com.analog.study_watch_sdk.application

Class PPGApplication

java.lang.Object

com.analog.study_watch_sdk.application.CommonApplication

com.analog.study_watch_sdk.application.PPGApplication

public class PPGApplication
extends CommonApplication

PPG Application class.

Field Summary

Fields

Modifier and Type	Field and Description
PPGLcfgID	LCFG_ID_ADPD107
PPGLcfgID	LCFG_ID_ADPD108
PPGLcfgID	LCFG_ID_ADPD185
PPGLcfgID	LCFG_ID_ADPD188
PPGLcfgID	LCFG_ID_ADPD4000
Stream	STREAM_DYNAMIC_AGC
Stream	STREAM_HRV
Stream	STREAM_PPG
Stream	STREAM_SYNC_PPG

Constructor Summary

Constructors

Constructor and Description
PPGApplication(PacketManager packetManager)

Method Summary

Modifier and Type	Method and Description
PPGDCBCommandPacket	deleteDeviceConfigurationBlock() Deletes 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.
VersionPacket	getAlgoVersion() Returns Algorithm version info.
LibraryConfigDataPacket	getLibraryConfiguration() Returns entire library configuration PPG.
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.
PPGLcfgID[]	getSupportedLcfgIDs() List all supported PPG LCFG IDs.
Stream[]	getSupportedStreams() List all supported streams for PPG.
VersionPacket	getVersion() Returns version info.
PPGDCBPacket	readDeviceConfigurationBlock() Returns entire device configuration block.
PPGLibraryConfigPacket	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.
CommandPacket	setLibraryConfiguration(PPGLcfgID lcfgID) Set PPG to specified library configuration.
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.
PPGDCBCommandPacket	writeDeviceConfigurationBlock(long[][] addressesValues) Writes the device configuration block values of specified addresses.
PPGDCBCommandPacket	writeDeviceConfigurationBlockFromFile(java.io.File file) Writes the device configuration block values of specified addresses from file.
PPGLibraryConfigPacket	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

LCFG_ID_ADPD107

public PPGLcfgID LCFG_ID_ADPD107

LCFG_ID_ADPD185

public PPGLcfgID LCFG_ID_ADPD185

LCFG_ID_ADPD108

public PPGLcfgID LCFG_ID_ADPD108

LCFG_ID_ADPD188

public PPGLcfgID LCFG_ID_ADPD188

LCFG_ID_ADPD4000

public PPGLcfgID LCFG_ID_ADPD4000

STREAM_PPG

public Stream STREAM_PPG

STREAM_HRV

public Stream STREAM_HRV

STREAM_SYNC_PPG

public Stream STREAM_SYNC_PPG

STREAM_DYNAMIC_AGC

public Stream STREAM_DYNAMIC_AGC

Constructor Detail

PPGApplication

public PPGApplication(PacketManager packetManager)

Method Detail

getPacketLostCount

public int getPacketLostCount(Stream stream)

Returns number of packets lost during stream.

Parameters:

stream - stream.

deleteDeviceConfigurationBlock

public PPGDCBCommandPacket deleteDeviceConfigurationBlock()

Deletes Device configuration block.

Returns:

PPGDCBPacket

getLibraryConfiguration

public LibraryConfigDataPacket getLibraryConfiguration()

Returns entire library configuration PPG.

Returns:

LibraryConfigDataPacket

getSupportedLcfgIDs

public PPGLcfgID[] getSupportedLcfgIDs()

List all supported PPG LCFG IDs.

Returns:

PPGLcfgID[]

readDeviceConfigurationBlock

public PPGDCBPacket readDeviceConfigurationBlock()

Returns entire device configuration block.

Returns:

PPGDCBPacket

readLibraryConfiguration

public PPGLibraryConfigPacket readLibraryConfiguration(long[] fields)

Reads library configuration from specified field values.

Parameters:

fields - array of field values to read.

Returns:

PPGLibraryConfigPacket

 +----------------------+----------------------+
 | Fields Lower Limit   |  Fields Upper Limit  |
 +----------------------+----------------------+
 |       0x00           |      0x34            |
 +----------------------+----------------------+
 

setLibraryConfiguration

public CommandPacket setLibraryConfiguration(PPGLcfgID lcfgID)

Set PPG to specified library configuration.

Parameters:

lcfgID - PPG lcfg_id to set, use getSupportedLcfgIDs() to list all supported lcfg IDs

Returns:

CommandPacket

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.

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.

writeDeviceConfigurationBlock

public PPGDCBCommandPacket writeDeviceConfigurationBlock(long[][] addressesValues)

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:

PPGDCBPacket

 +----------------------+----------------------+
 | Address Lower Limit  |  Address Upper Limit |
 +----------------------+----------------------+
 |       0x00           |      0x34            |
 +----------------------+----------------------+
 

writeDeviceConfigurationBlockFromFile

public PPGDCBCommandPacket writeDeviceConfigurationBlockFromFile(java.io.File file)
                                                          throws java.io.IOException

Writes the device configuration block values of specified addresses from file.

Parameters:

file - dcb file.

Returns:

PPGDCBPacket

 +----------------------+----------------------+
 | Address Lower Limit  |  Address Upper Limit |
 +----------------------+----------------------+
 |       0x00           |      0x34            |
 +----------------------+----------------------+
 

Throws:

java.io.IOException

writeLibraryConfiguration

public PPGLibraryConfigPacket writeLibraryConfiguration(long[][] fieldsValues)

Writes library configuration from List of fields and values.

Parameters:

fieldsValues - array of fields and values to write.

Returns:

PPGLibraryConfigPacket

 +----------------------+----------------------+
 | Fields Lower Limit   |  Fields Upper Limit  |
 +----------------------+----------------------+
 |       0x00           |      0x34            |
 +----------------------+----------------------+
 

getSupportedStreams

public Stream[] getSupportedStreams()

List all supported streams for PPG.

Returns:

Stream[]

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

getVersion

public VersionPacket getVersion()

Returns version info.

Returns:

VersionPacket

getAlgoVersion

public VersionPacket getAlgoVersion()

Returns Algorithm version info.

Returns:

VersionPacket

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.