BIAApplication

java.lang.Object
- com.analog.study_watch_sdk.application.CommonApplication
- - com.analog.study_watch_sdk.application.BIAApplication

public class BIAApplication
extends CommonApplication

BIA Application class.

Field Summary

Fields
Modifier and Type	Field and Description
`DCBConfigBlockIndex`	`BIA_DCFG_BLOCK`
`DCBConfigBlockIndex`	`BIA_LCFG_BLOCK`
`BIADFTWindow`	`DFT_WINDOW_1024`
`BIADFTWindow`	`DFT_WINDOW_128`
`BIADFTWindow`	`DFT_WINDOW_16`
`BIADFTWindow`	`DFT_WINDOW_16384`
`BIADFTWindow`	`DFT_WINDOW_2048`
`BIADFTWindow`	`DFT_WINDOW_256`
`BIADFTWindow`	`DFT_WINDOW_32`
`BIADFTWindow`	`DFT_WINDOW_4`
`BIADFTWindow`	`DFT_WINDOW_4096`
`BIADFTWindow`	`DFT_WINDOW_512`
`BIADFTWindow`	`DFT_WINDOW_64`
`BIADFTWindow`	`DFT_WINDOW_8`
`BIADFTWindow`	`DFT_WINDOW_8192`
`HSResistorTIA`	`RESISTOR_1K`
`HSResistorTIA`	`RESISTOR_200`
`HSResistorTIA`	`RESISTOR_5K`
`Stream`	`STREAM_BCM`
`Stream`	`STREAM_BIA`

Constructor Summary

Constructors
Constructor and Description

BIAApplication(PacketManager packetManager)

Constructors
Constructor and Description
`BIAApplication(PacketManager packetManager)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HSRTIAPacket`	`calibrateHSResistorTIA(HSResistorTIA hsResistorTIA)` Calibrate High Speed Resistor Trans Impedance Amplifier.
`BIADCBCommandPacket`	`deleteDeviceConfigurationBlock(DCBConfigBlockIndex dcbBlockIndex)` Deletes ECG Device configuration block.
`void`	`disableCSVLogging(Stream stream)` Stop logging stream data into CSV.
`void`	`enableCSVLogging(java.io.File file, Stream stream)` Start logging stream data into CSV.
`BIADCFGPacket`	`getDeviceConfiguration(long[] addresses)` Get device configuration.
`int`	`getPacketLostCount(Stream stream)` Returns number of packets lost during stream.
`StreamStatusPacket`	`getSensorStatus(Stream stream)` Returns packet with number of subscribers and number of sensor start request registered.
`BIADFTWindow[]`	`getSupportedDFTWindows()` List all supported DFT window for BCM.
`HSResistorTIA[]`	`getSupportedHSResistorTIAs()` List all supported High Speed Resistor Trans Impedance Amplifier for BCM.
`Stream[]`	`getSupportedStreams()` List all supported streams for PPG.
`CommandPacket`	`loadDeviceConfiguration()` Load device configuration.
`BIADCBPacket`	`readDeviceConfigurationBlock(DCBConfigBlockIndex dcbBlockIndex)` Returns entire device configuration block.
`BIALibraryConfigPacket`	`readLibraryConfiguration(long[] fields)` Reads library configuration from specified field values.
`void`	`setCallback(java.lang.Object userCallback, Stream stream)` Sets the callback for the stream data.
`BIADCFGPacket`	`setDeviceConfiguration(long[][] addressesValues)` Set device configuration.
`BIADFTPacket`	`setDiscreteFourierTransformation(BIADFTWindow dftWindow)` Set Discrete Fourier Transformation for BCM.
`StreamPacket[]`	`startAndSubscribeStream(Stream stream)` Starts PPG sensor and also subscribe to the PPG stream.
`StreamPacket`	`startSensor()` Start PPG sensor.
`StreamPacket[]`	`stopAndUnsubscribeStream(Stream stream)` Stops PPG sensor and also Unsubscribe the PPG stream.
`StreamPacket`	`stopSensor()` Stops PPG sensor.
`StreamPacket`	`subscribeStream(Stream stream)` Subscribe to the specified PPG stream.
`void`	`subscribeStreamData(Stream stream)` Add custom callback for raw stream packets.
`StreamPacket`	`unsubscribeStream(Stream stream)` Unsubscribe the specified PPG stream.
`void`	`unsubscribeStreamData(Stream stream)` Remove custom callback for raw stream packets.
`void`	`updateSubscribeTimestamp(java.util.Calendar cal, Stream stream, boolean generateTS)` Update timestamp for subscribing, only to be used when changing the base reference time for the stream.
`CommandPacket`	`writeDCBToLCFG()` Writes Device configuration block data to library configuration.
`BIADCBCommandPacket`	`writeDeviceConfigurationBlock(long[][] addressesValues, DCBConfigBlockIndex dcbBlockIndex)` Writes the device configuration block values of specified addresses.
`BIADCBCommandPacket`	`writeDeviceConfigurationBlockFromFile(java.io.File file, DCBConfigBlockIndex dcbBlockIndex)` Writes the device configuration block values of specified addresses from file.
`BIALibraryConfigPacket`	`writeLibraryConfiguration(long[][] fieldsValues)` Writes library configuration from List of fields and values.

Methods inherited from class com.analog.study_watch_sdk.application.CommonApplication
setTimeout

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESISTOR_200
```
public HSResistorTIA RESISTOR_200
```

RESISTOR_1K
```
public HSResistorTIA RESISTOR_1K
```

RESISTOR_5K
```
public HSResistorTIA RESISTOR_5K
```

STREAM_BIA
```
public Stream STREAM_BIA
```

STREAM_BCM
```
public Stream STREAM_BCM
```

BIA_LCFG_BLOCK

public DCBConfigBlockIndex BIA_LCFG_BLOCK

BIA_DCFG_BLOCK

public DCBConfigBlockIndex BIA_DCFG_BLOCK

DFT_WINDOW_4
```
public BIADFTWindow DFT_WINDOW_4
```

DFT_WINDOW_8
```
public BIADFTWindow DFT_WINDOW_8
```

DFT_WINDOW_16
```
public BIADFTWindow DFT_WINDOW_16
```

DFT_WINDOW_32
```
public BIADFTWindow DFT_WINDOW_32
```

DFT_WINDOW_64
```
public BIADFTWindow DFT_WINDOW_64
```

DFT_WINDOW_128
```
public BIADFTWindow DFT_WINDOW_128
```

DFT_WINDOW_256
```
public BIADFTWindow DFT_WINDOW_256
```

DFT_WINDOW_512
```
public BIADFTWindow DFT_WINDOW_512
```

DFT_WINDOW_1024
```
public BIADFTWindow DFT_WINDOW_1024
```

DFT_WINDOW_2048
```
public BIADFTWindow DFT_WINDOW_2048
```

DFT_WINDOW_4096
```
public BIADFTWindow DFT_WINDOW_4096
```

DFT_WINDOW_8192
```
public BIADFTWindow DFT_WINDOW_8192
```

DFT_WINDOW_16384
```
public BIADFTWindow DFT_WINDOW_16384
```

Constructor Detail

BIAApplication

public BIAApplication(PacketManager packetManager)

Method Detail
- getSupportedStreams
```
public Stream[] getSupportedStreams()
```
  List all supported streams for PPG.
  
  Returns:
  
  Stream[]
- setCallback
```
public void setCallback(java.lang.Object userCallback,
                        Stream stream)
```
  Sets the callback for the stream data.
  
  Parameters:
  
  userCallback - Callback function for specified adpd stream.
  
  stream - Callback for specified stream.
- getPacketLostCount
```
public int getPacketLostCount(Stream stream)
```
  Returns number of packets lost during stream.
  
  Parameters:
  
  stream - stream.
- getSupportedDFTWindows
```
public BIADFTWindow[] getSupportedDFTWindows()
```
  List all supported DFT window for BCM.
  
  Returns:
  
  BIADFTWindow[]
- getSupportedHSResistorTIAs
```
public HSResistorTIA[] getSupportedHSResistorTIAs()
```
  List all supported High Speed Resistor Trans Impedance Amplifier for BCM.
  
  Returns:
  
  HSResistorTIA[]
- calibrateHSResistorTIA
```
public HSRTIAPacket calibrateHSResistorTIA(HSResistorTIA hsResistorTIA)
```
  Calibrate High Speed Resistor Trans Impedance Amplifier.
  
  Parameters:
  
  hsResistorTIA - High Speed Resistor Trans Impedance Amplifier to calibrate, use get_supported_hs_resistor_tia_ids() to list all supported resistor.
  
  Returns:
  
  HSRTIAPacket
- setDiscreteFourierTransformation
```
public BIADFTPacket setDiscreteFourierTransformation(BIADFTWindow dftWindow)
```
  Set Discrete Fourier Transformation for BCM.
  
  Parameters:
  
  dftWindow - DFT window for Discrete Fourier Transformation, use getSupportedDFTWindows() to list all supported DFT window.
  
  Returns:
  
  DFTPacket
- readLibraryConfiguration
```
public BIALibraryConfigPacket readLibraryConfiguration(long[] fields)
```
  Reads library configuration from specified field values.
  Parameters:
  
  fields - array of field values to read.
  
  Returns:
  BIALibraryConfigPacket
```
 +----------------------+----------------------+
 | Fields Lower Limit   |  Fields Upper Limit  |
 +----------------------+----------------------+
 |       0x00           |      0x03            |
 +----------------------+----------------------+
 
```
- writeLibraryConfiguration
```
public BIALibraryConfigPacket writeLibraryConfiguration(long[][] fieldsValues)
```
  Writes library configuration from List of fields and values.
  Parameters:
  
  fieldsValues - array of fields and values to write.
  
  Returns:
  BIALibraryConfigPacket
```
 +----------------------+----------------------+
 | Fields Lower Limit   |  Fields Upper Limit  |
 +----------------------+----------------------+
 |       0x00           |      0x03            |
 +----------------------+----------------------+
 
```
- writeDCBToLCFG
```
public CommandPacket writeDCBToLCFG()
```
  Writes Device configuration block data to library configuration.
  
  Returns:
  
  CommandPacket
- deleteDeviceConfigurationBlock
```
public BIADCBCommandPacket deleteDeviceConfigurationBlock(DCBConfigBlockIndex dcbBlockIndex)
```
  Deletes ECG Device configuration block.
  
  Returns:
  
  BIADCBPacket
- readDeviceConfigurationBlock
```
public BIADCBPacket readDeviceConfigurationBlock(DCBConfigBlockIndex dcbBlockIndex)
```
  Returns entire device configuration block.
  
  Returns:
  
  BIADCBPacket
- writeDeviceConfigurationBlock
```
public BIADCBCommandPacket writeDeviceConfigurationBlock(long[][] addressesValues,
                                                         DCBConfigBlockIndex dcbBlockIndex)
```
  Writes the device configuration block values of specified addresses. This function takes a list of addresses and values to write, and returns a response packet as dictionary containing addresses and values.
  Parameters:
  
  addressesValues - array of addresses and values to write.
  
  Returns:
  BIADCBPacket
```
 +----------------------+----------------------+
 | Address Lower Limit  |  Address Upper Limit |
 +----------------------+----------------------+
 |       0x00           |      0x02            |
 +----------------------+----------------------+
 
```
- writeDeviceConfigurationBlockFromFile
```
public BIADCBCommandPacket writeDeviceConfigurationBlockFromFile(java.io.File file,
                                                                 DCBConfigBlockIndex dcbBlockIndex)
                                                          throws java.io.IOException
```
  Writes the device configuration block values of specified addresses from file.
  Parameters:
  
  file - dcb file.
  
  Returns:
  BIADCBPacket
```
 +----------------------+----------------------+
 | Address Lower Limit  |  Address Upper Limit |
 +----------------------+----------------------+
 |       0x00           |      0x02            |
 +----------------------+----------------------+
 
```
  Throws:
  
  java.io.IOException
- enableCSVLogging
```
public void enableCSVLogging(java.io.File file,
                             Stream stream)
```
  Start logging stream data into CSV.
  
  Parameters:
  
  file - csv file.
  
  stream - stream enum.
- disableCSVLogging
```
public void disableCSVLogging(Stream stream)
```
  Stop logging stream data into CSV.
  
  Parameters:
  
  stream - stream enum.
- getDeviceConfiguration
```
public BIADCFGPacket getDeviceConfiguration(long[] addresses)
```
  Get device configuration.
  
  Parameters:
  
  addresses - List of field values to read.
  
  Returns:
  
  BIADCFGPacket
- setDeviceConfiguration
```
public BIADCFGPacket setDeviceConfiguration(long[][] addressesValues)
```
  Set device configuration.
  
  Parameters:
  
  addressesValues - List of addresses and values to set.
  
  Returns:
  
  BIADCFGPacket
- loadDeviceConfiguration
```
public CommandPacket loadDeviceConfiguration()
```
  Load device configuration.
  
  Returns:
  
  CommandPacket
- getSensorStatus
```
public StreamStatusPacket getSensorStatus(Stream stream)
```
  Returns packet with number of subscribers and number of sensor start request registered.
  
  Returns:
  
  StreamStatusPacket
- startAndSubscribeStream
```
public StreamPacket[] startAndSubscribeStream(Stream stream)
```
  Starts PPG sensor and also subscribe to the PPG stream.
  
  Returns:
  
  StreamPacket[]
- startSensor
```
public StreamPacket startSensor()
```
  Start PPG sensor.
  
  Returns:
  
  StreamPacket
- stopAndUnsubscribeStream
```
public StreamPacket[] stopAndUnsubscribeStream(Stream stream)
```
  Stops PPG sensor and also Unsubscribe the PPG stream.
  
  Returns:
  
  StreamPacket[]
- stopSensor
```
public StreamPacket stopSensor()
```
  Stops PPG sensor.
  
  Returns:
  
  StreamPacket
- subscribeStream
```
public StreamPacket subscribeStream(Stream stream)
```
  Subscribe to the specified PPG stream.
  
  Parameters:
  
  stream - Stream to subscribe.
  
  Returns:
  
  StreamPacket
- unsubscribeStream
```
public StreamPacket unsubscribeStream(Stream stream)
```
  Unsubscribe the specified PPG stream.
  
  Parameters:
  
  stream - Stream to unsubscribe.
  
  Returns:
  
  StreamPacket
- updateSubscribeTimestamp
```
public void updateSubscribeTimestamp(java.util.Calendar cal,
                                     Stream stream,
                                     boolean generateTS)
```
  Update timestamp for subscribing, only to be used when changing the base reference time for the stream.
- subscribeStreamData
```
public void subscribeStreamData(Stream stream)
```
  Add custom callback for raw stream packets.
- unsubscribeStreamData
```
public void unsubscribeStreamData(Stream stream)
```
  Remove custom callback for raw stream packets.

Class BIAApplication

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.analog.study_watch_sdk.application.CommonApplication

Methods inherited from class java.lang.Object

Field Detail

RESISTOR_200

RESISTOR_1K

RESISTOR_5K

STREAM_BIA

STREAM_BCM

BIA_LCFG_BLOCK

BIA_DCFG_BLOCK

DFT_WINDOW_4

DFT_WINDOW_8

DFT_WINDOW_16

DFT_WINDOW_32

DFT_WINDOW_64

DFT_WINDOW_128

DFT_WINDOW_256

DFT_WINDOW_512

DFT_WINDOW_1024

DFT_WINDOW_2048

DFT_WINDOW_4096

DFT_WINDOW_8192

DFT_WINDOW_16384

Constructor Detail

BIAApplication

Method Detail

getSupportedStreams

setCallback

getPacketLostCount

getSupportedDFTWindows

getSupportedHSResistorTIAs

calibrateHSResistorTIA

setDiscreteFourierTransformation

readLibraryConfiguration

writeLibraryConfiguration

writeDCBToLCFG

deleteDeviceConfigurationBlock

readDeviceConfigurationBlock

writeDeviceConfigurationBlock

writeDeviceConfigurationBlockFromFile

enableCSVLogging

disableCSVLogging

getDeviceConfiguration

setDeviceConfiguration

loadDeviceConfiguration

getSensorStatus

startAndSubscribeStream

startSensor

stopAndUnsubscribeStream

stopSensor

subscribeStream

unsubscribeStream

updateSubscribeTimestamp

subscribeStreamData

unsubscribeStreamData