Home

BioRadio SDK LabView

1. BioRadio Example vi la og File Edit Operate Tools Browse Window Help Device Configuration Data Collection Ping device de Program from file Interval ms BioRadio ConfigFile Path We i C iCleveMMediClsveLabslConfigF iles ILabDA Basics ini S BioRadio Data Channel 1 Channel 2 STOP Amplitude Radio Link Status GoodPackets i631 BadPackets 5 DroppedPackets 7 Data Point BioRadio Config File Path The example VI by default pings the BioRadio User Unit for its current device configuration If you are using a RatPaak or wish to program the BioRadio to a particular configuration at Start change the toggle in the Device Configuration panel to Program from file and specify the path to the appropriate file before running the VI Consult the BioRadio User s Manual for more information on configuration files Data Collection Interval The Data Collection Interval specifies how often in milliseconds the software collects data from the PC s communication port where the Computer Unit has deposited it The port has a finite buffer only so much data can accumulate there between collections when cleared before the buffer fills and is incapable of holding more Therefore if the data collection interval is set too high the buffer will overfill and data will be lost the Dropped Packets count will increase The maximum time to which you can set the data collection interval while avoid
2. is presented to the user to allow selection between the discovered devices shown right The user can choose a device or cancel the dialog to choose none The appropriate information regarding this choice is then returned by the VI following the previous prescription A Legacy Device is connected to the PC using USB identically as a non legacy device but recognized as USB Serial interface and communicated with through a serial COM port Currently the RatPaak is the only BioRadio device with non legacy support acting in a purely USB manner During device discovery a progress dialog is displayed If the Device Name and Type Legacy or Non and the Port Number to which it is connected are already known it is unnecessary to use the Find and Choose Receiver VI as these parameters can be supplied manually Version 1 2 9 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide CleveMed 02 14 2006 B HN Cleveland Medical Devices Inc Usage Radio Find T Outputs Name Type Description Device Name String Type of device connected or chosen by user BioRadio 150 RatPaak or if none connected or chosen Port Number Long Integer port number to which the chosen device is connected corresponds to serial COM port number for legacy devices and USB port identifier for non legacy devices if none is found or chosen Legacy Device Boolean True if
3. BioRadio is acting as legacy USB Serial device see Overview in this section for more on Legacy Devices Version 1 2 10 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide 02 14 2006 Starting Base Communication BioRadio_StartBaseComm vi Overview CleveMed B HN Cleveland Medical Devices Inc Operating with knowledge of the type of BioRadio connected and on which port communication with the Computer Unit is initiated If the device is a BioRadio 150 the BioRadio150 DLL is used to perform the following A BioRadio object is created CreateBioRadio Communication with the Computer Unit is initiated Start BaseComm If the device is a RatPaak no action is taken For the RatPaak this VI s functionality is assumed when acquisition is started and it need not be used Usage Le ETE 1524 ji Inputs Name Type Description Required Device Name String Device BioRadio 150 or RatPaak Yes Port Number Long Integer Identifying number of the port to which the Yes device is connected COM Port if Legacy Device USB identifier if non Legacy Outputs Name Type Description Device Handle Unsigned Long Integer If the device is a BioRadio 150 the handle reference to the device in use Otherwise 1 is returned See Multiple BioRadio 150s and the Object Handle above Version 1 2 11 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Drive
4. CleveMed B HN Cleveland Medical Devices Inc BioRadio Software Development Kit LabVIEW Driver Guide BioRadio SDK LabVIEW Driver Guide M d duds CleveMe B HN Cleveland Medical Devices Inc Telephone 216 791 6720 or Toll free 1 877 CleveMed 1 877 253 8363 9 00 a m 5 00 p m EST Monday Friday Fax 216 791 6739 E Mail Customer Support support daCleveMed com Sales sales CleveMed com Web http www CleveMed com Mailing Address Cleveland Medical Devices Inc 4415 Euclid Avenue Fourth Floor Cleveland Ohio 44103 Cleveland Medical Devices Inc 1999 2006 Version 1 2 2 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide durus CleveMed B HN Cleveland Medical Devices Inc Table of Contents Ufo g s 16107 re A Er T 4 honc H 4 NOE Saa TC rn 5 BioRadio MES Hc dacs 3 Multiple Devices and the Object Handle aie diee nitro in etin rate t inre uon dos ae ai n end aine 3 Paths to DLEEs in Driver VIs c 5 lon hin ls Cini Rd p EE RE E S 7 Bi R di Config File PUE aeo aaxeacsniendeaacinanseaastanduxtstiaa stag euenseanGnarnnaesterdaune EE arrean que NUN iat 7 Data Collection Interval is isco TR a E 7 Radio Link SAMUS sseui e R E EE EA R EEE A AEE 8 Finding and Choosing Attached Devices eseeseeesssesesresstseesresstsstesresstrsetsressttstesrenstesseseeesreset 9 OVVIE Wannen NEM opens UM M MEM DEMNM
5. Communication with the Computer Unit is ended stopBaseComm Destroy the software device object Dest royBioRadio If the device is a RatPaak no action is taken For the RatPaak this VI s functionality is assumed when acquisition is stopped and it need not be used Usage abet Bio C Device Handle Radio hil er ee Inputs Name Type Description Required Device Name String Device BioRadio 150 or RatPaak Yes Device Handle Unsigned Long Integer Handle reference to the device in use Yes Version 1 2 18 Cleveland Medical Devices Inc 1999 2006
6. M wo as M EUM MN 9 Boo c ee ee 10 lr PT 10 Starting Base Communication isis eias Y Rar e MARO NOE EAR SR n ERRES Sen NEAN PRR RE MEN p OE FERE Ss eo EMRUHK A HR MER Te PRU E EE 11 ONA BATA DT 11 MUS eS E oan 11 loc M 11 lop MT 11 Starine ACUS O S boxe bas bte ba dad cvi atc salstvncaedcass Dice EUM I DU E tee 12 rj 12 EET 12 lo c EE 12 Prog P 13 Acgu ming Pri T A 14 ic C 14 NISC 15 Ioui c M m A 15 e gp d I 15 SIODDIBE JXOEDTSEUDOT iiec bius bita nec dud oda icd tatus uu aies a pde nie ulta enna o ated 17 MDL Ws sce se 17 MTSE area essa osc E E 17 PUIS TL EE a EEEE EE EEEE 17 Stoppi
7. ackets transferred since Start Sample Rate Double Prec Floating Samples per second for fast inputs defined by currently Point loaded configuration Version 1 2 16 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide dod CleveMed B HN Cleveland Medical Devices Inc Stopping Acquisition BioRadio Stop vi Overview Stop acquisition For the RatPaak additionally stop communication with Computer Unit and release reserved memory If the device is a BioRadio 150 the BioRadio150 DLL is used to perform the following Stop acquisition StopAcq If the device is a RatPaak the RatPaak DLL is used to perform the following Stop BioRadio communication StopAcq Destroy the software device object DestroyRatPaak Usage ETT Bio c Device Handle Radio W TET A Inputs Name Type Description Required Device Name String Device BioRadio 150 or RatPaak Yes Device Handle Unsigned Long Integer Handle reference to the device in use Yes Version 1 2 17 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide dod CleveMed B HN Cleveland Medical Devices Inc Stopping Base Communication BioRadio StopBaseComm vi Overview For the BioRadio 150 at the end of a session communication with the Computer Unit should be terminated and reserved memory released If the device is a BioRadio 150 the BioRadio150 DLL is used to perform the following
8. d Boolean bit array 10 bits of which starting from least significtant corresponding to enabled state of a fast input starting from first fast input Ch 1 EnabledSlowInputs Word Boolean bit array 5 bits of which starting from least significtant corresponding to enabled state of a slow input starting from first slow input Accelerometer X Device Handle out Unsigned Long Integer Handle reference to the device in use Otherwise 1 is returned See Multiple BioRadio 150s and the Object Handle above Started Boolean Whether the device was successfully started Programmed Boolean Whether the device was successfully programmed or pinged Sample Rate Double Prec Floating Samples per second for fast inputs defined by Point currently loaded configuration 13 Version 1 2 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide ieee CleveMed B HN Cleveland Medical Devices Inc Acquiring Data BioRadio Read vi Overview Once acquisition has been started the user will want to begin and repeat acquiring data received at the PC s communications port If the device is a BioRadio 150 the BioRadio150 DLL is used to perform the following 1 Instruct the device to prepare its data buffer for reading TransferBuffer 2 Acquire the sample rate and number of inputs on which the data is being read GetSampleRate GetNumEnabledFastInputs GetNumEnabledSlowInputs 3 Establish array s fast inputs array and op
9. good transmission between Computer Unit and User Unit and provided data is collected regularly All three indicators are reset each time acquisition is started Version 1 2 8 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide Varo CleveMed E NB NH Cleveland Medical Devices Inc Finding and Choosing Attached Devices BioRadio FindAndChooseReceiver vi Overview The first step in communicating with a BioRadio is generally to discover and identify attached BioRadio receivers and if multiple exist to choose between them The BioRadio Find and Choose Receiver VI uses the FindReceivers function provided by the DeviceCheck DLL to discover BioRadio and RatPaak Computer Units connected to the user s PC The DLL function displays a dialog informing the user that searching is in progress and acts in different ways depending on the results of the search e If exactly one BioRadio receiver is found TL H1 the function returns the name of the bi ec 39 ec 23 device BioRadio 150 or Rat pdak the number of the port to which it is attached and whether the device is acting Multiple BioRadio devices are connected to your computer asa legacy COM port device or non Please choose one to use with this session legacy USB e fno BioRadio device is found outputs Raak USES reflect this e Ifmultiple BioRadio devices are found a modal dialog 0k BioRadio_DialogChooseBioRadio vi
10. ing dropped Version 1 2 7 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide ieee CleveMed B HN Cleveland Medical Devices Inc packets is dependent upon buffer size PC speed and what else is taking up processing time in the computer 80ms milliseconds between reads is a typical value Radio Link Status The Radio Link Status box provides three metrics on the radio link between the BioRadio transmitter and receiver measured in radio data packets A packet of information sent from the transmitter to the receiver includes a time stamp the sampled data and other variables to allow software processing A packet can only include so much information as its size does not vary Therefore if the unit is programmed to acquire data on only 1 or 2 inputs a packet may have up to 3 samples for each input whereas a packet including data over eight inputs will include only one sample per input The Good Packets indicator reflects the number of error free data packets received from the User Unit The number of Good Packets should increase rapidly while the transmitter is on Bad Packets is the count of data packets received from the User Unit but found to be corrupted Dropped Packets is the total number of packets lost in transmission and padded with the Bad Data Value The Dropped Packets total includes packets never received as well as Bad Packets Both Bad and Dropped Packets should remain close to zero provided a
11. ng Base Communication eseseseesseseeesieeesrtsstsetestressteerestessesstestessttstestessetstesteestesteseresrenet 18 Rag M 18 Hor 18 i TT 18 Version 1 2 3 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide dod CleveMed B HN Cleveland Medical Devices Inc Introduction The software DLL Dynamic Link Library interface to the BioRadio allows for programmatic interaction in Windows applications Such interaction has been designed for National Instruments LabVIEW development system allowing BioRadio and RatPaak communications and control from within LabVIEW and LabVIEW based applications This document describes the LabVIEW Virtual Instruments VIs provided for such utility and their appropriate usage The BioRadio SDK LabVIEW Driver consists of the following Win32 DLLs the software interface to the devices DeviceCheckDLL dl BioRadioDLL dll BioRadio150DLL dl RatPaakDLL dll and the following LabVIEW VIs which make calls to functions within the DLLs BioRadio FindAndChooseReceiver vi BioRadio DialogChooseBioRadio vi BioRadio Start vi BioRadio StartBaseComm vi BioRadio Read vi BioRadio Stop vi BioRadio StopBaseComm vi BioRadio Example vi Basic Operation Communicating with a BioRadi
12. o through LabVIEW is divided into six main actions listed here and described in more detail further in this document Note that for the RatPaak Starting Base Communication is accomplished by Starting Acquisition and Stopping Base Communication is accomplished by Stopping Acquisition only one Start and one Stop routine are needed Finding and Choosing Attached Devices Identify attached BioRadio receivers and if multiple exist choose between them Starting Base Communication Create a software device object and start communication between the PC and Computer Unit Starting Acquisition Start communication between the Computer Unit and User Unit attend to device configuration and communication parameters and begin acquiring data Acquiring Data Read and interpret scaled data from the port buffer and acquire transmission statistics Stopping Acquisition Stop data acquisition and communication between Computer Unit and User Unit Version 1 2 4 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide ieee CleveMed B HN Cleveland Medical Devices Inc Stopping Base Communication Stop communication between PC and Computer Unit and destroy the software device object Notes BioRadio Models The LabVIEW Driver uses multiple DLLs to support various BioRadio models The DLL interface for device discovery DeviceFinder DLL is designed to work with the BioRadio 150 and RatPaak Individual device control i
13. r Guide Varo CleveMed B HN Cleveland Medical Devices Inc Starting Acquisition BioRadio Start vi Overview Operating with knowledge of the type of BioRadio connected and its handle BioRadio 150 or USB ID RatPaak communication with the User Unit is attempted and data acquisition intiated If the device is a BioRadio 150 the BioRadio150 DLL is used to perform the following Data acquisition is initiated StartAcq The data value returned when packets are dropped is set Set BadDataValue Device configuration is optionally set or acquired ProgramConfig PingConfig Meta data is acquired GetNumEnabledFast Inputs GetEnabledFastInputs GetNumEnabledSlowInputs GetEnabledSlowInputs GetSampleRate If the device is a RatPaak the RatPaak DLL is used to perform the following A RatPaak object is created CreateRatPaak The supplied configuration file is loaded Loadconfig The value returned on dropped packets is set SetBadDataValue Data acquisition is initiated StartAcq Meta data is gathered Get SampleRate If the device was properly started it is optionally programmed ProgramConfig During Start Programming and Pinging progress dialogs are displayed Usage TRH Inputs Name Type Description Required Device Handle Unsigned Long Integer Handle reference to the BioRadio 150 in When using in use See Multiple BioRadio 150s and the BioRadio 150 Version 1 2 12 Cleveland Medical Device
14. s Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide 02 14 2006 CleveMed B HN Cleveland Medical Devices Inc Object Handle above PortNum Long Integer Identifying number of the port to which the When using device is connected COM Port if Legacy RatPaak Device USB identifier if non Legacy DeviceName String Device BioRadio 150 or RatPaak Yes ProgramDevice Boolean Whether the device should be programmed Yes to the provided configuration file upon starting communications BioRadio Path LabVIEW path variable to the configuration If ProgramDevice ConfigFile Path file to which the device should be or when using programmed if it should be programmed RatPaak BadDataValue Double Prec Floating Value to which invalid missing data should No Point be set default 0 PingConfig Boolean Whether the device should be pinged and its Yes current configuration loaded into the object If ProgramDevice is set to True PingConfig will be ignored LegacyDevice Boolean True if BioRadio has USB Serial When using interface see Finding And Choosing RatPaak Attached Devices Name Type Description NumEnabledFastInputs Long Integer Number of fast inputs on which data will be acquired based on device configuration NumEnabledSlowInputs Long Integer Number of slow inputs on which data will be acquired based on device configuration EnabledFastInputs Wor
15. s handled by a few DLLs BioRadio DLL BioRadio150 DLL and RatPaak DLL Each LabVIEW VI is designed to operate with both the BioRadio 150 and RatPaak devices Since each model requires its own DLL communications interface the VIs contain logic to choose the appropriate DLL for the model being used Multiple Devices and the Object Handle The BioRadio SDK allows for operation of and acquisition from multiple BioRadios and Ratpaaks simultaneously Each time a device object is created BioRadio StartBaseComm vi or BioRadio Start vi for the RatPaak is run with parameters referencing a valid Computer Unit the handle reference to the object is returned Subsequent VIs called to operate upon this device must be provided the corresponding object s handle Paths to DLLs in Driver Vis LabVIEW s Call Library Function node responsible for making calls to DLL functions specifies absolute paths to DLLs a Call Library Function node BioRadio150 TransferBuffer If upon opening the driver VIs the DLL is not located at the path specfied such as on first run LabVIEW searches for the files and displays a dialog while doing so BioRadio Read vi x Loading 2 Loaded E Development BioRadio SDK LabView BioRadio SDK LabViewARatPaakDLL RatPaakDLL dil Searching C Builds Copy of Capture 2 0 source CaptureAPl Ignore Library Browse Stop LabVIEW searches for a DLL If the search utility does not immedia
16. tely find the DLLs click Browse to locate the files yourself All DLL references in the VI will be updated and saved when the VI is saved These paths are always manually editable from Call Library Function node properties within a VI Version 1 2 5 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide are CleveMed NB HN Cleveland Medical Devices Inc m Call Library Function Library Name or Path P lProductslBioRadio LabVIEW DriverlBioRadio Labview Driver Files BioRadio150DLL dll Function Name TransferBuffer iv Run in UI Thread iw Calling Conventions C v Parameter return type iv Type Numeric w Add a Parameter Before Data Type Signed 32 bit Integer v m Add a Parameter After Delete this Parameter Function Prototype long _TransferBuffer void Call Library Function node properties change the DLL path Version 1 2 6 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide ieee CleveMed B HN Cleveland Medical Devices Inc BioRadio Example VI BioRadio Example vi is included to illustrate use of the driver functions to acquire data from the BioRadio a starting point for creating your own custom BioRadio applications This VI as provided will operate properly with a BioRadio or RatPaak device programmed for two 2 data input channels The task of customization is left to the developer
17. tional slow inputs array of double precision floating point values fast inputs array sized to the return value of TransferBuffer and initialized to 32768 4 Read the data from the device s buffer into this array ReadScaledData ReadScaledFastAndSlowData 5 Multiply each data point by 1 000 000 to scale to uV millivolts 6 De interleave data into 2 dimensional array s whose rows correspond to input channels 7 Acquire link status data GetGoodPackets GetBadPackets GetDroppedPackets If the device is a RatPaak the RatPaak DLL is used to perform the following 1 Instruct the device to prepare its data buffer for reading TransferBuffer 2 Acquire the sample rate and number of inputs on which the data is being read GetSampleRate GetNumChannels 3 Establish a 655360 element array of double precision floating point values initialized to 327168 4 Read the data from the device s buffer into this array ReadScaled 5 Multiply each data point by 1 000 000 to scale to uV millivolts 6 De interleave data into a 2 dimensional array whose rows correspond to input channels 7 Acquire link status data GetGoodPackets GetBadPackets GetDroppedPackets Version 1 2 14 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide 02 14 2006 Usage astInputsData E EL Bio c CleveMed B HN Cleveland Medical Devices Inc ast input 2 Note that the number of arrays into which the Fast SlowInp
18. utsData arrays will be de interleaved is dictated by the number of enabled inputs Three are shown here for each Inputs Name Type Description Required Device Name String Device BioRadio 150 or RatPaak Yes Device Handle Unsigned Long Integer Handle reference to the device in use Yes Outputs Name Type Description FastInputsData 2d array of Double Prec Data acquired on Fast Inputs each row of the array Floating Point representing an input channel each column with one data point SlowInputsData 2d array of Double Prec Data acquired on Slow Inputs BioRadio 150 only each Floating Point row of the array representing an input channel each column with one data point FastInputsNumRead Long Integer Number of data points read over all fast inputs SlowInputsNumRead Long Integer Number of data points read over all slow inputs BioRadio 150 only NumFastInputs Long Integer Number of enabled Fast Inputs Version 1 2 15 Cleveland Medical Devices Inc 1999 2006 BioRadio SDK LabVIEW Driver Guide CleveMed 02 14 2006 B HN Cleveland Medical Devices Inc NumSlowInputs Long Integer Number of enabled Slow Inputs BioRadio 150 only GoodPackets Unsigned Long Integer Number of valid packets transferred since Start BadPackets Unsigned Long Integer Number of corrupted packets transferred since Start DroppedPackets Unsigned Long Integer Number of dropped p

BioRadio SDK LabView

Contents

Download Pdf Manuals

Related Search

Related Contents