adi_spo2_watch package

Subpackages

Submodules

adi_spo2_watch.sdk module

exception adi_spo2_watch.sdk.ConnectionAlreadyExistError

Bases: Exception

exception adi_spo2_watch.sdk.DongleNotFoundError

Bases: Exception

class adi_spo2_watch.sdk.SDK(serial_port_address: str, mac_address: str = None, baud_rate: int = 921600, board=<Board.STUDY_WATCH: ['0x00']>, logging_filename: str = None, debug: bool = False, sync_date_time=True, check_version=True, ble_vendor_id: int = 1110, ble_product_id: int = 11518, ble_serial_number: str = None, ble_timeout: int = 10, **kwargs)

Bases: object

SDK class

FW_VERSION = '6.7.0'
JOINING_CSV = 1
READING_LOG = 0
SPO2_WATCH = [3]
STUDY_WATCH = [0]
VSM_MB_SB = [1]
static convert_log_to_csv(filename, display_progress=True, progress_callback=None)

Converts M2M2 log file into csv.

convert_ticks_to_timestamp(ticks: int)

Converts firmware ticks to unix timestamp.

disconnect()

disconnect SDK

get_ad7156_application()

Creates a ad7156 application object

Returns:

a AD7156 Application

Return type:

AD7156Application

get_adp5360_application()

Creates an adp5360 application object

Returns:

an ADP5360 Application

Return type:

ADP5360Application

get_adpd_application()

Creates an adpd application object

Returns:

an Adpd Application

Return type:

ADPDApplication

get_adxl_application()

Creates an adxl application object

Returns:

an Adxl Application

Return type:

ADXLApplication

static get_available_ports() List

returns the list of tuple (port, description, hardware_id) of available ports.

get_bia_application()

Creates a bia application object

Returns:

a BIA Application

Return type:

BIAApplication

get_ecg_application()

Creates an ecg application object

Returns:

an ecg Application

Return type:

ECGApplication

get_eda_application()

Creates an eda application object

Returns:

an eda Application

Return type:

EDAApplication

get_fs_application()

Creates an fs application object

Returns:

an fs Application

Return type:

FSApplication

get_low_touch_application()

Creates a low touch application object

Returns:

a LowTouch Application

Return type:

LowTouchApplication

get_lt_mode4_application()

Creates a lt_mode4 application object

Returns:

a lt_mode4 Application

Return type:

LTMode4Application

get_max30208_application()

Creates a Max30208 application object

Returns:

a Max30208 Application

Return type:

MAX30208Application

get_pedometer_application()

Creates an pedometer application object

Returns:

an pedometer Application

Return type:

PedometerApplication

get_pm_application()

Creates an pm application object

Returns:

an pm Application

Return type:

VSMPMApplication

get_ppg_application()

Creates an ppg application object

Returns:

an Ppg Application

Return type:

PPGApplication

get_sensorhub_application()

Creates a Sensor Hub application object

Returns:

a Sensor Hub Application

Return type:

SensorHubApplication

get_sqi_application()

Creates a sqi application object

Returns:

a SQI Application

Return type:

SQIApplication

static get_supported_boards()
get_temperature_application()

Creates a temperature application object

Returns:

a Temperature Application

Return type:

TemperatureApplication

get_test_application(key_test_callback=None, cap_sense_callback=None)

Creates a test application object, used for internal firmware testing.

Returns:

a Test Application

Return type:

TestApplication

get_user0_application()

Creates a User0 application object

Returns:

a User Application

Return type:

User0Application

static join_csv(*args, output_filename='combined.csv', display_progress=True, progress_callback=None)

Joins multiple data stream csv file into single csv file.

reconnect(serial_port_address: str, mac_address: str = None, baud_rate: int = 921600, board=<Board.STUDY_WATCH: ['0x00']>, logging_filename: str = None, debug: bool = False, sync_date_time=False, check_version=False, ble_vendor_id: int = 1110, ble_product_id: int = 11518, ble_serial_number: str = None, ble_timeout: int = 10, **kwargs)

reconnect method allows you to reconnect to SDK; you must call disconnect before using connect.

Parameters:
  • serial_port_address – serial port of the device connected.

  • mac_address – MAC address of the device.

  • baud_rate – baud rate.

  • board – board to connect (STUDY_WATCH, VSM_MB_SB).

  • logging_filename – log file name.

  • debug – control for debug mode.

  • sync_date_time – Sync current system date and time with firmware (Default=False).

  • check_version – Check for SDK and firmware compatibility (Default=False).

  • ble_vendor_id – BLE Vendor ID for ADI dongle (Default=0x0456).

  • ble_product_id – BLE Product ID for ADI dongle (Default=0x2CFE).

  • ble_serial_number – BLE Serial Number ID for ADI dongle, if none then it will choose first device with given vendor and product ID (Default=None).

  • ble_timeout – BLE connection timeout (Default=10).

set_alarms_callback(callback_function, args=())
unsubscribe_all_streams()

Unsubscribe from all application streams

Module contents