adi_study_watch package¶
Subpackages¶
- adi_study_watch.application package
- ad7156_application module
- adp5360_application module
- adpd_application module
- adxl_application module
- bia_application module
- common_application module
- common_stream module
- ecg_application module
- eda_application module
- fs_application module
- low_touch_application module
- pedometer_application module
- pm_application module
- ppg_application module
- sqi_application module
- temperature_application module
- user0_application module
- adi_study_watch.core package
- Subpackages
- adi_study_watch.core.enums package
- ad7156_enums module
- adpd_enums module
- adxl_enums module
- bia_enums module
- board_enums module
- common_enums module
- dcb_enums module
- display_enums module
- ecg_enums module
- eda_enums module
- fs_enums module
- low_touch_enums module
- pedometer_enums module
- pm_enums module
- ppg_enums module
- sqi_enum module
- user0_enum module
- adi_study_watch.core.packets package
- ad7156_packets module
- adpd_packets module
- adxl_packets module
- bia_packets module
- command_packet module
- common_packets module
- display_packets module
- ecg_packets module
- eda_packets module
- fs_packets module
- low_touch_packets module
- pm_packets module
- ppg_packets module
- sqi_packets module
- stream_data_packets module
- temperature_packets module
- user0_packets module
- adi_study_watch.core.enums package
- Submodules
- core.ble_manager module
- core.packet_manager module
- core.utils module
- Subpackages
Submodules¶
adi_study_watch.sdk module¶
-
class
adi_study_watch.sdk.SDK(serial_port_address: str, mac_address: Optional[str] = None, baud_rate: int = 921600, board=<Board.STUDY_WATCH: ['0x00']>, logging_filename: Optional[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: Optional[str] = None, ble_timeout: int = 10, **kwargs)¶ SDK class
-
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
-
get_adp5360_application()¶ Creates an adp5360 application object
- Returns
an ADP5360 Application
- Return type
ADP5360Application
-
get_adp5360_application()¶ Creates an adp5360 application object
- Returns
an ADP5360 Application
- Return type
-
get_adpd_application()¶ Creates an adpd application object
- Returns
an Adpd Application
- Return type
-
get_adxl_application()¶ Creates an adxl application object
- Returns
an Adxl Application
- Return type
-
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
-
get_ecg_application()¶ Creates an ecg application object
- Returns
an ecg Application
- Return type
-
get_eda_application()¶ Creates an eda application object
- Returns
an eda Application
- Return type
-
get_fs_application()¶ Creates an fs application object
- Returns
an fs Application
- Return type
-
get_low_touch_application()¶ Creates a low touch application object
- Returns
a LowTouch Application
- Return type
-
get_pedometer_application()¶ Creates an pedometer application object
- Returns
an pedometer Application
- Return type
-
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
-
get_sqi_application()¶ Creates a sqi application object
- Returns
a SQI Application
- Return type
-
get_temperature_application()¶ Creates a temperature application object
- Returns
a Temperature Application
- Return type
-
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
-
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: Optional[str] = None, baud_rate: int = 921600, board=<Board.STUDY_WATCH: ['0x00']>, logging_filename: Optional[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: Optional[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).
-
unsubscribe_all_streams()¶ Unsubscribe from all application streams
-
static