0% found this document useful (0 votes)
159 views19 pages

BDI 2.0 Manual

This document provides instructions for using the BDI 2.0 software to transfer data from Boule Medical AB's BM800 and BM850 hematology analyzers to a PC. The software allows selection of parameters to transfer and outputs the data to XML, Excel, and text files. It supports connections via serial ports or USB and can monitor multiple instruments. Proper configuration of the analyzers and setting the COM port and output folders in the software settings are described.

Uploaded by

adelabra
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
159 views19 pages

BDI 2.0 Manual

This document provides instructions for using the BDI 2.0 software to transfer data from Boule Medical AB's BM800 and BM850 hematology analyzers to a PC. The software allows selection of parameters to transfer and outputs the data to XML, Excel, and text files. It supports connections via serial ports or USB and can monitor multiple instruments. Proper configuration of the analyzers and setting the COM port and output folders in the software settings are described.

Uploaded by

adelabra
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 19

BDI 2.

0 Manual
BM800/BM850 Data Interface

Boule Medical AB Domnarvsgatan 4 SE-163 53 Spånga, Sweden Phone +46 8 744 77 00, Fax +46 8 744 77 20, E-mail: [email protected]
Contents
1. Introduction ..................................................................................................................................................................3
2. Requirements ...............................................................................................................................................................3
3. Installation ...................................................................................................................................................................3
4. Windows Environment ................................................................................................................................................3
5. Typical Configurations BM800 ...................................................................................................................................4
6. Typical Configurations BM850 ...................................................................................................................................6
7. Main Program Window................................................................................................................................................7
8. Settings Window ..........................................................................................................................................................8
9. Output Files..................................................................................................................................................................9
10. Transferred Data ..........................................................................................................................................................9
11. Parameters .................................................................................................................................................................. 10
11.1. Static Instrument Parameters ........................................................................................................................... 10
11.2. Instrument Configuration Parameters .............................................................................................................. 10
11.3. Sample Identification Parameter Values.......................................................................................................... 10
11.4. Aspiration Parameters...................................................................................................................................... 11
11.5. Differentiation – White Cells........................................................................................................................... 12
11.6. Control Blood with Reference Ranges ............................................................................................................ 12
11.7. Settings ............................................................................................................................................................ 12
11.8. Reagent statistics ............................................................................................................................................. 13
11.9. Sample Result Parameter Values ..................................................................................................................... 15
12. Limitations and Requirements ................................................................................................................................... 17
13. FAQ ........................................................................................................................................................................... 18

CENTURI 13241-3 2
1. Introduction
BM800/BM850 (BM8xx) Data Interface (BDI) is intended for transferring data from BM8xx instrument to PC or as a
sample data interface between BM8xx and LIS systems.

Features
- Transfer data from BM8xx (USB, RS232) to PC (USB, RS232)
- Parse sample data from files
- Supports multiple channels / instruments (hardware dependent)
- Selectable parameters
- Outputs data to xml, Excel (via stylesheets) and txt (TAB separated data)
- Validation of transferred data

2. Requirements
- PC with USB and/or RS232 ports
- Windows 7/8
- .NET 4.5

3. Installation
See Installation Instructions (included in the zip-file)

NOTE 1 This manual refers to version 2.0 of BDI software. Future revision changes could make this information
obsolete. Only use the manual that was included in the installed software package.

NOTE 2 Always set Serial Output Setup - Send with Ack to enabled according to section 5 in order to ensure safe data
transfer between BM8xx and PC (See section 4).

4. Windows Environment

Program Location: Setup will create a shortcut to the program in the start menu.

Default output Folder: C:\Users\”user name”\AppData\Roaming\Boule Medical\BouleDataInterface\BM8xx_Data.

CENTURI 13241-3 3
5. Typical Configurations BM800

A single BM800 is connected to PC via COM port (RS232)

OR

A single BM800 is connected to PC via Instrument USB host – RS232/USB adapter – PC COM port (RS232)

1. Connect BM800 to an available COM port on PC (note which number this port have in the PC manual)
2. Configure BM800 communications settings as follows

3. Open BDI and add a channel via Tools / Settings / Add


4. Set Com port to the number selected in 1
5. Select which parameters to enable
6. Press the save button

CENTURI 13241-3 4
A single BM8xx is connected to PC via USB port

1. Connect BM8xx to USB device port on PC (see image above for position)
2. Install USB drivers (see Installation documentation, included in the zip file)
3. Configure both BM8xx communications settings as follows

4. Open BDI and add a channel via Tools / Settings / Add


5. Set Com port to the virtual com port assigned to the instrument in step 2
6. Select which parameters to enable
7. Press the save button

CENTURI 13241-3 5
6. Typical Configurations BM850

A single BM8xx is connected to PC via USB port

1. Connect BM850 to USB device port on PC (see image above for position)
2. Install USB drivers (see Installation documentation, included in the zip file)
3. On BM850, enable “Send by USB-to-USB” in Export Target screen.
4. On BM850, enable “Send with Ack” in Export Setup screen.

5. Open BDI and add a channel via Tools / Settings / Add


6. Set Com port to the virtual com port assigned to the instrument in step 2
7. Select which parameters to enable
8. Press the save button

CENTURI 13241-3 6
7. Main Program Window

Connection / Data Log Displays configured connections and status. This text box can also be
configured to display real-time status of parsed sample data.

File - Open File Opens a file (BM8xx data stored on USB memory) to parse data.

File - Exit Close BDI

Tools - Settings Open settings window

Tools - Restart Channel Restarts a single channel (only communication is restarted, not BM8xx).

Tools - Restart All Channels Restarts all channels (only communication is restarted, not BM8xx).

Tools - Datalog / No Datalog Select if parse information for current sample shall be displayed in the
Connection / Data Log window.

Tools - Clear Screen Clears the Connection / Data Log screen.

Help About BDI version information

CENTURI 13241-3 7
8. Settings Window

Instrument Connection Select com port (RS232 or virtual via BM8xx driver)

COM Port - Available Port(s) Display a list of available COM ports.

COM Port - Baud Rate Selected baud rate (not changeable).

Output Dir Path to this channels selected output folder.

Sample Data / Transferred data Select which parameters to be parsed and stored on file. This is a global
setting affecting all channels.

Add Add a channel to connect additional BM8xx (default is one channel).

Remove Remove selected channel.

Default Set settings to default factory mode.

CENTURI 13241-3 8
9. Output Files
BDI 2 have a fixed output set containing xml, xsl (for Excel) and txt files.

XML - Format Description All transferred samples are stored in a single .xml file. A new file is
created each day.

XML - File name BM8xx_Instrument ID_Date.xls


Example: BM8xx_50559_2015-03-25.xls

XLS - Format Description Use this file to import xml data into Excel by dragging the xml file to
Excel and the select to import the file with the style sheet (the dialog will
be shown automatically). A new xls file is created for each sample.

TXT - Format Description Each .txt file contains a single sample in TAB separated format. One
parameter for each row.

TXT - File name Sample ID_Date_Sequence.txt


Example: AUTOBACKGROUND_2010-03-23_s7979.txt

10. Transferred Data


Following parameters are available: SNO, IID, ID, SEQ, DATE, SORC, STYP, ASPM, ASPS, BLMD, BLNK,
ASWP, RPD, RPDS, RPDL, RPDH, RPDF, WDMS, WDMA, WDFB,
WDLL, WDLH, WDCL, WDCH, LGL, WDIL, WDIH, WDDM, WDDP,
CAPL, CLVL, CEXP, CEXT, RGED, RGEL, RGEC, APNU, APNA,
XLT, RDLI, RDPN, RDED, RLLI, RLPN, RLED, RCLI, RCPN, RCED,
RBC, MCV, HCT, MCH, MCHC, RDWR, RDWA, PLT, MPV, PCT,
PDW, LPCR, HGB, WBC, LA, MA, GA, LR, MR, GR, EA, ER

Select which parameter to include in Tools / Settings / Transferred Data.

Note: All received parameters are always included in both the xml and the txt files. This selection only affect the style
sheet that will make corresponding visible in Excel. If setting is changed and new files are generated in the same output
directory that will affect visible parameters when old files are opened in Excel! Both for added and removed
parameters”

CENTURI 13241-3 9
11. Parameters

11.1. Static Instrument Parameters


The static instrument parameters are parameters that are always the same during the instrument life cycle.

9.1.1 SNO - Serial Number


SNO is a 5-digit (BM800) or 6-digit (BM850) serial number. This number is unique for each instrument.

Value range: BM800: 00001 – 65534.


BM850: 000001 – 999999.

11.2. Instrument Configuration Parameters


The instrument configuration parameters are "semi-static" instrument parameters. The parameters are probably
the same during the instrument life cycle, but may change, for example after a software upgrade.

11.2.1 FIWV - Firmware Version


FIWV identifies the software used in the instrument. This parameter is always present with a value.

11.2.2 IID - User-Settable Instrument ID


IID identifies an individual BM8xx instrument. It is a user settable string of 1-15 characters. This parameter is
always present, but the value is only present if the instrument ID is set.

11.3. Sample Identification Parameter Values


Sample identification parameter values identify the sample run.

11.3.1 ID - Blood Sample ID


ID is the identification of the blood sample. This parameter is always present, but the value is absent for
"blank" ID:s.

Value range: BM800 0 - 15 characters


BM850 0 - 50 characters

Note 1: Non-numeric characters are allowed. Leading or trailing white space will be filtered away.
Note 2: Non-ASCII characters may be used.
Note 3: All control blood sample ID:s are a number followed by a trailing "+". (The number is normally
the digits of the lot number of the control blood.)
Note 4: Leading zero digits in ID numbers are significant.
Note 5: The maximum number of characters in ID numbers may change.

11.3.2 SEQ - Sample Sequence Number


SEQ is the sequence number of the sample run. This parameter is always present with a value.

Value range: BM800 1 - 9999


BM850 1 - 99999

Note 1: SEQ numbers are not unique in samples from one instrument. The operator can set the sequence
number of the next sample, and sequence numbers wraps around.
Note 2: The upper limit of sequence numbers may change.

11.3.3 DATE - Sample Date and Time


DATE is the date and time of the sample run. This parameter is always present with a value except when
the date and time is not set in the instrument. The value is always formatted according to ISO 8601. See
example below. The date and time is always in the local time zone. No time zone info is provided.

Example: 2004-05-06T07:08:09

CENTURI 13241-3 10
11.3.4 SORC – Sample or Control
SORC indicates if it is a normal sample run or a control sample run. This parameter is always present with a
value.

Value range: 0: normal sample


2: control sample with reference ranges

Note 1: More sample or control types may be added. They will all be small positive numbers.

11.4. Aspiration Parameters

11.4.1 ASPM - Aspiration Mode


ASPM indicates the aspiration mode for the sample. This parameter is always present with a value.

Value Description: "OT" Open Tube


"PD" Pre-diluted sample
"CT" Closed Tube = Cap piercer
"MC" Micro capillary = MPA / MCI
"AS" Auto sampler

11.4.2 ASPS – Aspiration Status


ASPS indicates the aspiration status for the run. This parameter is always present with a value.
The value is a status flag indicating if blood (or some other sample type) was detected during aspiration.

Value range: 0: no blood (or other) detected


1: blood (or other) detected
2: indeterminate due to e.g. timeout during aspiration

11.4.3 BLMD - Background Mode Sample Run


BLMD indicates if the sample was run in background mode. Background mode is used for blank test runs.
This parameter is always present with a value.

Value range: 0: not background mode


1: background mode

Note: the parameter BLNK indicates if the sample actually was a blank sample.

11.4.4 BLNK - Blank Sample


BLNK indicates if the sample was a blank sample run or not, determined by the instrument. This parameter is always
present with a value.

Value range: 0: not a blank sample


1: a blank sample

Note: The definition of a blank is RBC < 0,50 and HGB < 2,0 (below approx 15% of a normal human blood
sample).

11.4.5 ASWP - Auto-sampler Wheel Position


ASWP indicates the wheel position for an auto-sampler run. This parameter is always present. The value is only
present for auto-sampler samples.

Value range: 1 - 20.

CENTURI 13241-3 11
11.5. Differentiation – White Cells
The BM8xx instrument has several different methods to separate the complete WBC population into three
subpopulations: LYM, MID , GRAN (in increasing size order). The instrument configuration allows or disallows
selection of the different WBC diff methods.

11.5.1 WDMA - WBC Diff Method Actually Used


WDMA indicates the floating WBC diff method actually used during the calculations. This parameter is always
present. The value is only present if the instrument actually tried a WBC diff.

Value range: 1: DM1 human floating


2: DM2 fixed
4: DM4 vet floating

Note 1: more diff methods may be added. They will all be small positive numbers.

11.6. Control Blood with Reference Ranges


The operator inputs control blood assay information to specify reference ranges and other information about a
control blood. All control blood lots have a unique ID number that is used to separate different control blood lots.

Note 1: The unique ID number is normally the digits from the control blood lot number followed by a plus
(+) sign. Example: lot number “0606-123” gets the ID number “0606123+”.
Note 2: Leading zero digits in control blood ID numbers are significant.

11.6.1 CLVL – Control Blood Level


CLVL identifies the level (normal/low/high/calibrator) of a control blood with reference ranges. This parameter is
always present. The value is only present if the blood was a control blood with reference ranges. The value is a one-
character string: "N" for normal level, "L" for low level, "H" for high level, and "C" for calibrator. Other control
blood levels may be added. All control blood level codes will be one uppercase letter.

Note 1: This information comes from the control blood reference range assay information.
Note 2: The control blood level is also present as a name in the parameter APNA (see 9.9.2)

11.6.2 CEXP - Expiry Date of a Control Blood with Reference Ranges


CEXP is the expiry date of a control blood with reference ranges. This parameter is always present. The value is only
present if the blood was a control blood with reference ranges.

The value is a date, always formatted according to ISO 8601. See example below.

Note: This information comes from the control blood reference range assay information.

Example: 2005-03-09

11.7. Settings

11.7.1 APNA – Analysis Profile Name / control blood level name


APNA is the name (if defined) of the Analysis Profile (species in vet instruments) selected for the sample. This
parameter is always present. The value is present if a name is defined for the selected Analysis Profile (species). A
qualified operator can set the value of this parameter.

The value is a string of 1 to 15 characters.

Note 1: Non-ASCII characters may be used.


Note 2: The initial instrument setup uses "BLOOD" for the “blood” analysis profile, and
"BACKGROUND" for “background”. The control bloods with reference ranges have "LOW",
"NORMAL", "HIGH", and "CALIBRATOR".
Note 3: The predefined names in the previous note may be translated to other languages.
Note 4: A qualified operator can set the names of analysis profiles.

CENTURI 13241-3 12
11.8. Reagent statistics
The BM8xx instrument has an optional reagent statistics system that keeps track of the reagents used in the
instrument.

Note: The diluent and hemolyzing regent information is exactly the same if a reagent “combo” pack is used.

11.8.1 RDLI Reagent Statistics Diluent Lot identifier


RDLI is the lot identifier of the diluent reagent. This parameter is always present. The value is only present if the
reagent statistics system is enabled.

The value is always formatted as “YYMM-NNN”, where YY, MM and NNN are digits. (Normally YY =
production year, MM =production month and NNN = lot sequence number.) See example below.

Note 1: This information comes from the reagent package information.


Note 2: leading zero digits in reagent lot identifiers are significant.

Example: 0606-123

11.8.2 RDED Reagent Statistics Diluent Expiry date


RDED is the expiry date of the diluent reagent. This parameter is always present. The value is only present if the
reagent statistics system is enabled.

The value is a date, always formatted according to ISO 8601. See example below.

Note: This information comes from the reagent package information.

Example: 2006-06-29

11.8.3 RLLI Reagent Statistics Hemolyzer Lot identifier


RLLI is the lot identifier of the hemolyzing reagent. This parameter is always present. The value is only present if the
reagent statistics system is enabled.

The value is always formatted as “YYMM-NNN”, where YY, MM and NNN are digits. (Normally YY =
production year, MM =production month and NNN = lot sequence number.) See example below.

Note 1: This information comes from the reagent package information.


Note 2: leading zero digits in reagent lot identifiers are significant.

Example: 0606-124

11.8.4 RLED Reagent Statistics Hemolyzer Expiry date


RLED is the expiry date of the hemolyzing reagent. This parameter is always present. The value is only present if the
reagent statistics system is enabled.

The value is a date, always formatted according to ISO 8601. See example below.

Note: This information comes from the reagent package information.

Example: 2006-06-29

CENTURI 13241-3 13
11.8.5 RCLI Reagent Statistics Cleaner Lot identifier
RCLI is the lot identifier of the cleaning reagent. This parameter is optional, and may be present in vet instruments.
The value is only present if the reagent statistics system is enabled.

The value is always formatted as “YYMM-NNN”, where YY, MM and NNN are digits. (Normally YY =
production year, MM =production month and NNN = lot sequence number.) See example below.

Note 1: This information comes from the reagent package information.


Note 2: leading zero digits in reagent lot identifiers are significant.

Example: 0606-125

11.8.6 RCED Reagent Statistics Cleaner Expiry date


RLED is the expiry date of the cleaning reagent. This parameter is optional, and may be present in vet instruments.
The value is only present if the reagent statistics system is enabled.

The value is a date, always formatted according to ISO 8601. See example below.

Note: This information comes from the reagent package information.

Example: 2006-06-29

CENTURI 13241-3 14
11.9. Sample Result Parameter Values
Sample result parameter values are the measured and calculated hematology parameters from a sample run.
The parameter order below is not fixed. The parameters might be in another order. Parameter definitions may be
added or removed with new software releases.

11.9.1 Result Parameter Values

Figure 3: Parameter values

CENTURI 13241-3 15
11.9.2 Result Parameter Format
For each parameter a set of 5 values are present

Parameter Name Value


ParamaterName Actual parameter value
ParameterName_L Low range value
ParameterName_H High range value
ParameterName_F Flag value
ParameterName_O Out of range flag

A result parameter always has a Parameter name and a normal / reference range (ParamaterName_L,
ParamaterName_H) . It could also have a value (ParamaterName) or an out-of range (ParamaterName_O)
flag, and an error flag (ParamaterName_F).

Example (PLT, Background within range, no error flag present)

PLT 3
PLT_L 0
PLT_H 10
PLT_F
PLT_O

11.9.3 Parameter Value


The data type of the result parameters is either floating point or scaled integer.
For example, if the instrument counts RBC as 0.00, then there are no cells to calculate an MCV value from. The
instrument reports the RBC value as 0.00, since it did actually not count any cells, but the MCV value is absent.

The value range and the number of decimals depend of the parameter.

The parameter value and out of range value are mutually exclusive. A value is either not calculated (neither "value"
nor "out of range value", calculated ("value" only), or “out-of-range " only.

11.9.4 Parameter Out-of-Range


The " ParameterName_O " tag is only present if the parameter value is either completely out-of-range, or could not
be determined for some unusual reason. For example, if the MCV value is absent due to a blank run, then there is no
" ParameterName_O " tag. But if the RBC value is absent due to a ridiculously high count (above 14 in human
models), then BM8xx outputs a " ParameterName_O: H".

The " ParameterName_O " flag can take the values "H" (value too high) or "L" (value too low).
The " ParameterName_O " and " ParameterName" values are mutually exclusive. A value is either not calculated
(neither " ParameterName " nor " ParameterName_O "), calculated ("ParameterName" only), or out-of-range
("ParameterName_O " only).

11.9.5 Parameter Error Flag


The " ParameterName_F" value is an optional parameter error flag. Some errors block the calculation of the
corresponding parameter value, while others provide additional information.

The error flag is always two upper-case letters, or one upper-case letter followed by a digit. The list of possible flags
are not included here.

Note: Only these parameters can have an error flag: RBC, MCV, PLT, HGB, WBC, LYM, MID, GRAN.

11.9.6 Parameter Normal/Reference Range Low


The "ParameterName_L" value is always present. Its value is the low end of the normal / reference(*) range. If the
parameter value is exactly equal to "ParameterName_L", then it is within the normal / reference range. (* It is called
the normal range for normal blood, and reference range for control blood with reference ranges.)

CENTURI 13241-3 16
11.9.7 Parameter Normal/Reference Range High
The "ParameterName_H" tag is always present. Its value is the high end of the normal / reference range. If the
parameter value is exactly equal to " ParameterName_H", then it is within the normal / reference range.

12. Limitations and Requirements

BM8xx ‘Send with Ack’ must be set to active for proper data transfer (NOTE! If “Send with Ack” is not set
sample data could be lost without any warnings.

If a sample have been lost and “Send with Ack” is activated, the error will be indicated by BM8xx (A beep and a
Serial Output Alarm, no further samples will be sent until the issue is acknowledged manually).

All BM8xx sample data must be deleted manually by user input on the instrument. BDI does not change any data
or settings on the instrument.

CENTURI 13241-3 17
13. FAQ

Samples are lost when transferred from BM8xx to computer


1. Make sure that BM8xx is set to Send with Ack under Advanced -> Setup - >Serial.

BDI validates received data. All data that fails validation will be discarded. BDI signals BM8xx if a sample has been
transferred successfully by transmitting an acknowledge message. If Send with Ack is not set on BM8xx there is no
possibility for BM8xx to acknowledge that a sample needs to be re-transmitted.

2. Ensure that the computer meets stated requirements / Ensure that no unnecessary programs/services are
running on the computer.

BM8xx will timeout within 5 seconds after a sample is sent. If the computer is too slow, it may not allow for
validation and parsing within this time frame. It is also possible to increase the timeout period, see the instrument
user manual.

How do I know which COM port to use?


Connected via USB: After installing the BM8xx drivers, check the Ports section in Windows Device Manager. In the
example below COM4 is connected to a BM8xx instrument

Connected via RS232: You need to know which COM port connects to a physical port. One way to resolve this is to:
1. Use Settings -> Selected Port to select a COM port and click button ‘Save’.
2. If the program successfully connects to an instrument the serial number will be shown in the connection log. If
the connection fails serial number will be shown as N/A in the connection log. Retry with another COM port.

I disconnected the USB cable and now the program does not work
1. Click Tools -> Restart All Channels.
2. Remove and re insert USB cable at PC end.
3. Click Tools -> Restart All Channels.
4. Check the “Connection / Data Log” text box in main window to see if connection is on-line

If above 4 steps does not work close the application and restart.

(BM800) Ensure that the instrument is set to same VID/PID as used when installed the drivers.
(BM850) Try setting BM800 compatibility to “Enabled”

Where is the sample data?


1. Default location is: C:\Users\”user name”\AppData\Roaming\Boule
Medical\BouleDataInterface\BM8xx_Data (“user_name” is replaced by the current Windows account name.)
2. It is always possible to change the sample data directory from Tools / Settings / Output Dir

I sent the same sample twice but only one was transferred?
BDI will ignore the second sample for the xml file if two consecutive samples have the same sequence number and
Sample ID.

Boule Medical (2015)

CENTURI 13241-3 18
CENTURI 13241-3 19

You might also like