[PDF] BioTerm and BioStat User Manual - Biomark

33419_6BioTerm_and_BioStat_User_Manual_Rev2_1_1.pdf

USER MANUAL Revision 2

BioTerm & BioStat

SOFTWARE

705 S. 8

TH

Street BOISE, ID 83702 USA | 208.275.0011 | customerservice@biomark.com | www.biomark.com

Copyright and Trademarks

ii BioTerm and BioStat User Guide

Copyright

© Copyright 2017 Biomark, Inc. All rights reserved. This manual contains valuable proprietary information. It should not be published, copied, or communicated to any person without prior authorization from Biomark, Inc.

Trademarks

BioTerm, BioStat, IS1001 and IS1001-MC are trademarks of Biomark, Inc. All other trademarks, trade names, or images mentioned herein belong to their respective owners.

Document History

Release Date Doc Revision Software Version Comments

December, 2016 1 BioTerm 1.17.1

BioStat 1.8.2

Original release of this

guide .

January, 2017 2 BioTerm 1.18.0

BioStat 1.8.2

Updated links and BioTerm description to

match v1.18.0 .

Table of Contents

BioTerm and BioStat User Guide iii

Table of Contents

Using BioTerm .............................................................................................................................. 1

Configuring BioTerm Serial Port Settings .................................................................................. 1

Configuring BioTerm TCP Port Settings .................................................................................... 2

Configuring BioTerm Traffic List Settings .................................................................................. 3

Configuring BioTerm Data Export Setting

s ............................................................................... 4

Capturing Communication Messages ....................................................................................... 5

Updating BioTerm ..................................................................................................................... 5

Using BioStat

................................................................................................................................ 7

Configuring BioStat Serial Port Settings .................................................................................... 7

Configuring BioStat TCP Port Settings ...................................................................................... 8

Configuring BioStat Chart Settings ............................................................................................ 9

Configuring BioStat Traffic List Settings .................................................................................. 10

Configuring BioStat Data Export Settings ............................................................................... 11

Updating BioStat

..................................................................................................................... 11

BioStat Chart Examples .......................................................................................................... 13

Establishing USB Connection ..................................................................................................... 14

Establishing RS-232 Connection ................................................................................................ 15

Establishing Ethernet Connection ............................................................................................... 16

Establishing Bluetooth connection .............................................................................................. 19

Updating Device's Firmware

....................................................................................................... 22

Using BioTerm

1 BioTerm and BioStat User Guide

Using BioTerm

BioTerm is a communication and device managing program developed by Biomark. It is used to connect a computer to Biomark devices, such as IS1001, IS1001-MC, IS1001 Data Logger, BLE

Data Logger, etc.,

and perform communication and configuration tasks or update the device's firmware. BioTerm is configurable, it can be set to store real-time communication and tag data in a text file at user-defined location, and it is free to Biomark customers.

Note: BioTerm is available for download at:

https://www.biomark.com/technical/BioTerm/BioTerm.zip

Configuring BioTerm Serial Port Settings

Note: BioTerm connection to the device must be closed in order to modify the Serial Port settings. To configure Serial Port settings, select Tools > Settings > Serial Port Settings. Use this dialog to match Serial Port settings of the connected device: most Biomark devices' Serial Port communication is configured as follows: Parity: None Data Bits: 8 Stop Bits: 1 Flow Control: None Make any necessary changes and click on the Ok button to apply them.

Using BioTerm

BioTerm and BioStat User Guide 2

Configuring BioTerm TCP Port Settings

Note: BioTerm connection to the device must be closed in order to modify the TCP Port settings.

To configure TCP Port

settings, select Tools > Settings > TCP Port Settings. Use this dialog to set security features related to Ethernet connection: Channel 1 Password Enabled: must be selected when the connecting device's Lantronix

XPort Ethernet module

is configured so that Password Required option is enabled to establish the connection . Password, matching the one set in the XPort module, should be entered in provided space (case - sensitive). Channel 1 AES-256 Encryption Enabled: must be selected when the connecting device's Lantronix XPort Ethernet module is configured so that AES -

256 Encryption of the

communication is enabled. AES Encryption Key, matching the one set in the XPort module, should be entered in provided

4 lines.

Make any necessary changes and click on the Ok button to apply them.

Using BioTerm

3 BioTerm and BioStat User Guide

Note: Biomark devices use Lantronix XPort Ethernet modules. For additional information see the

Lantronix XPort User Guide available

at: http://www.lantronix.com/pdf/XPort_UG.pdf .

Configuring BioTerm Traffic List Settings

Note: BioTerm connection to the device must be closed in order to modify the traffic list settings. To configure the traffic list settings, select Tools > Settings > Traffic List Settings. Use this dialog to choose the font style and size that will be used to display communication traffic messages. Make any necessary changes and click on the Ok button to apply them.

Using BioTerm

BioTerm and BioStat User Guide 4

Configuring BioTerm Data Export Settings

Note: BioTerm connection to the device must be closed in order to modify the data export settings.

To configure data export

settings, select Tools > Settings > Data Export Settings. Use this dialog to set destination of a text file for saving communication traffic messages. Make any necessary changes and click on the Ok button to apply them.

Using BioTerm

5 BioTerm and BioStat User Guide

Capturing Communication Messages

BioTerm allows saving of the communication traffic messages into a text file, destination of which is defined in the Data Export Settings. To enable capturing the messages click on the Text

Capture

button within the main window of the BioTerm utility or select Tools > Enable Text

Capture

.

To disable capturing the

messages, click on the Text Capture button again or select Tools >

Disable Text Capture

.

Updating BioTerm

BioTerm checks for availability of an update automatically every 2 weeks upon startup and notifies a user if a new version is available.

To manually check for an

update, select Help > Check for Updates.

Using BioTerm

BioTerm and BioStat User Guide 6

If an update is available, follow the prompts

to get the BioTerm updated. After the update has been installed the BioTerm will restart automatically. If update is not available, the window will pop up stating that the BioTerm is up-to-date. Click on the OK button to close the window.

Using BioStat

7 BioTerm and BioStat User Guide

Using BioStat

BioStat

is a status monitoring program developed by Biomark. The program acquires a status report from the supported device, such as

IS1001

, IS1001 -

MC, etc.,

on a continual basis and displays the output in a graphical format. This provides an easy-to-read presentation of the device 's diagnostic data in real time. BioStat is configurable, it can be used to store diagnostic charts at user-defined intervals, and it is free to Biomark customers.

Note: BioStat is available for download at:

https://www.biomark.com/technical/BioStat/BioStat%201.8.2.zip

Configuring BioStat Serial Port Settings

Note: BioStat connection to the device must be closed in order to modify the Serial Port settings. To configure Serial Port settings, select Tools > Settings > Serial Port Settings. Use this dialog to match Serial Port settings of the connected device: most Biomark device s' Serial Port communication is configured as follows: Parity: None Data Bits: 8 Stop Bits: 1 Flow Control: None Make any necessary changes and click on the Ok button to apply them.

Using BioStat

BioTerm and BioStat User Guide 8

Configuring BioStat TCP Port Settings

Note: BioStat connection to the device must be closed in order to modify the TCP Port settings. To configure TCP Port settings, select Tools > Settings > TCP Port Settings. Use this dialog to set security features related to Ethernet connection: Channel 1 Password Enabled: must be selected when the connecting device's Lantronix

XPort Ethernet module

is configured so that Password Required option is enabled to establish the connection . Password, matching the one set in the XPort module, should be entered in the provided space (case-sensitive). Channel 1 AES-256 Encryption Enabled: must be selected when the connecting device's Lantronix XPort Ethernet module is configured so that AES-256 Encryption of the communication is enabled. AES Encryption Key, matching the one set in the XPort module, should be entered in the provided 4 lines. Make any necessary changes and click on the Ok button to apply them.

Using BioStat

9 BioTerm and BioStat User Guide

Note: Biomark devices use Lantronix XPort Ethernet modules. For additional information see the

Lantronix XPort User Guide available

at : http://www.lantronix.com/pdf/XPort_UG.pdf .

Configuring BioStat Chart Settings

Note: BioStat connection to the device must be closed in order to modify the chart settings. To configure chart settings, select Tools > Settings > Chart Settings. Use this dialog to specify how your charts will be generated and if they will be automatically saved: Max X Values: specifies the maximum number of data points used in a chart. When the limit is reached t he program will remove the oldest data point and add the most recent data point. Update Period: specifies how often a new data point is added to the chart. Charts Auto Scale Enabled: enables auto scaling of Y axis of the charts based on the values received . Charts Auto Saving: specifies if charts will be automatically saved by the program. Auto Saving Interval: specifies how often the charts will be saved (in minutes). Auto Saving Folder: specifies the location of the folder that will be used to store the charts files. Chart Saving Format: specifies the file format used when saving charts. Valid options are .png, .jpg, .bmp, .gif, .tif, and .emf. Make any necessary changes and click on the Ok button to apply them.

Using BioStat

BioTerm and BioStat User Guide 10

Configuring BioStat Traffic List Settings

Note: BioStat connection to the device must be closed in order to modify the traffic list settings. To configure the traffic list settings, select Tools > Settings > Traffic List Settings. Use this dialog to choose the font style and size that will be used to display communication traffic messages. Make any necessary changes and click on the Ok button to apply them.

Using BioStat

11 BioTerm and BioStat User Guide

Configuring BioStat Data Export Settings

Note: BioStat connection to the device must be closed in order to modify the data export settings. To configure data export settings, select Tools > Settings > Data Export Settings. Use this dialog to set the data export options: Export Values To .CSV File: select to save the charts' data in a form of .CSV file (comma separated values text file) and specify its destination. Capture Traffic To Text File: select to save the communication traffic messages in a text file and specify its destination. Make any necessary changes and click on the Ok button to apply them.

Updating BioStat

BioStat checks for availability of an update automatically every 2 weeks upon startup and notifies a user if a new version is available.

To manually check for an update

, select Help > Check for Updates.

Using BioStat

BioTerm and BioStat User Guide 12

If an update is available, follow the prompts

to get the BioStat updated. After the update has been installed the BioStat will restart automatically.

If update is not available

, the window will pop up stating that the BioStat is up-to-date. Click on the OK button to close the window.

Using BioStat

13 BioTerm and BioStat User Guide

BioStat Chart Examples

IS1001 FDX-B Signal tab, charts automatically

saved

IS1001 Detection Efficiency tab, charts not

auto-saved

Establishing USB Connection

BioTerm and BioStat User Guide 14

Establishing USB Connection

To establish the USB communication port connection: 1. Connect the device to the computer using an appropriate USB cable. Note: Proper device USB driver must be installed on your computer. Refer to the connecting device's User Manual for more specific information. 2. Power up the device. 3. Start the BioTerm or BioStat communication program.

Note: Not all devices are supported by BioStat.

4. In the Serial Port box, make sure that COMx is selected (where x is the port number assigned to the computer's USB port). For example: COM4 Silicon Labs CP210x USB to UART

Bridge

. 5. In the Baud Rate box, make sure you match the connecting device's USB port speed setting. 6. Make a serial port connection to the device by clicking on the Open button. 7. To verify the connection between the computer and the device, within BioTerm or BioStat

Traffic

window type ? and then press Enter. A list of the device's available commands should be displayed. 8. Type appropriate commands to perform the desired actions.

Establishing RS-232 Connection

15 BioTerm and BioStat User Guide

Establishing RS-232 Connection

To establish the

RS-232 communication port connection:

1. Connect the device to the computer using an RS-232 serial communication cable Note: Refer to the connecting device's User Manual for more specific information. 2. Power up the device. 3. Start the BioTerm or BioStat communication program.

Note: Not all devices are supported by BioStat.

4. In the Serial Port box, make sure that COMx is selected (where x is the port number assigned to the computer's RS-232 port or to USB port that has USB-to-Serial adapter connected to). 5. In the Baud Rate box, make sure you match the connecting device's RS-232 port speed settin g. 6. Make a serial port connection to the device by clicking on the Open button. 7. To verify the connection between the computer and the device, within BioTerm or BioStat

Traffic

window type ? and then press Enter. A list of the device's available commands should be displayed. 8. Type appropriate commands to perform the desired actions.

Establishing Ethernet Connection

BioTerm and BioStat User Guide 16

Establishing Ethernet Connection

To establish the

Ethernet

communication port connection: 1. Connect the device to the local area network using a CAT5 Ethernet cable. Note: Biomark devices use Lantronix XPort Ethernet modules. For additional information see the Lantronix XPort User Guide available at: http://www.lantronix.com/pdf/XPort_UG.pdf or refer to the connecting device's User Manual. 2. Power up the device. 3. Start the BioTerm or BioStat communication program.

Note: Not all devices are supported by BioStat.

4. Determine the device's IP address by selecting Tools > Lantronix Device Utilities and clicking on the

Search

button within the BioTerm or BioStat program.

This utility will scan

the network for Lantronix products and will display the IP addresses of the devices it finds. If there are multiple device s on the network use the MAC address of the device s' Ethernet module to h elp identify each one.

Establishing Ethernet Connection

17 BioTerm and BioStat User Guide 5. Select the desired device and then click on the Connect button to make the connection. If you receive an error when attempting the connection, make sure the BioTerm or BioStat communication parameters are configured as follows: IP address = the device's IP address Port = 10001 Connection type = TCP/IP

If connection problems persist or if the

device is not shown in the list of found devices, use the Lantronix DeviceInstaller utility to reconfigure the device's XPort Ethernet module.

Establishing Ethernet Connection

BioTerm and BioStat User Guide 18

6. To verify the connection between the computer and the device, within BioTerm or BioStat

Traffic

window type ? and then press Enter. A list of the device's available commands should be displayed. 7. Type appropriate commands to perform the desired actions.

Establishing Bluetooth connection

19 BioTerm and BioStat User Guide

Establishing

Bluetooth connection

To establish

the Bluetooth connection: 1. Power up the device. 2. Start the BioTerm communication program. Note: BioStat currently does not support Bluetooth connection. 3. Search for available devices by clicking on the Bluetooth Devices button within the main window of the BioTerm utility. Th e window will open where all discoverable Bluetooth devices appear. It might take up to a few minutes for all the Bluetooth devices to appear in the list. Note: Refer to the connecting device's User Manual for more specific information.

Establishing Bluetooth connection

BioTerm and BioStat User Guide 20

4. Find the device you want to connect to and double-click on it to establish the connection.

Establishing Bluetooth connection

21
BioTerm and BioStat User Guide 8. To verify the connection between the computer and the device, within BioTerm Traffic window type ? and then press Enter. A list of the device's available commands should be displayed. 9. Type the appropriate commands to perform the desired actions.

Updating Device"s Firmware

BioTerm and BioStat User Guide 22

Updating Device's Firmware

Important! As a precaution, download all tag IDs and other data contained in memory of the device before initiating the firmware update process. All settings of the device may get reset to the manufacturer default values during the update process, so it is recommended to take a note of the present settings prior to updating the firmware. Note: Refer to the device's User Manual for more specific information.

To update the

device's firmware: 1. Start the BioTerm communication program. Note: BioStat does not support device firmware update. 2. Make a connection to the device using any available communication port. 3. Select Tools > Update Device Firmware within the BioTerm utility. 4. Go to the location of the new firmware file, select it and then click on the Open button. 5. Click on the Start Programming button in the following window.

Updating Device"s Firmware

23
BioTerm and BioStat User Guide 6. In the confirmation dialog, click on the OK button. The firmware update process should take less than a minute to complete. 7. Wait for the update process to finish.

Updating Device"s Firmware

BioTerm and BioStat User Guide 24

8. In the Application Update - Success window, click on the OK button.

BioTerm and BioStat User Guide

705 S. 8th Street

Boise, Idaho 83702, USA

1-208-275-0011

www.biomark.com