e4client package

Module contents

class e4client.E4Connect(user: str = None, pwd: str = None)

Bases: object

Class that allows to interact with the E4 Connect platform. It allows to retrieve lists of sessions and devices and to download sessions data.

Parameters:

• user – Username to log in the E4 Connect platform.
• pwd – Password to log in the E4 Connect platform.

auth(user: str, pwd: str)

Allows to login in the platform and retrieves the related user ID. Cookies will be saved for later requests.

Parameters:

• user – Username to log in the E4 Connect platform.
• pwd – Password to log in the E4 Connect platform.

sessions_list() → list

Retrieves a list of all the sessions in the current session. It includes the following columns: id, device_id, duration, status, start_time, label device, exit_code.

Returns:list of dictionaries with information of the sessions.

download_session(session_id: str, file_path: str = '.')

Download all the data related with a specific session as a ZIP file. It includes the following parameters (separated in different files): ACC, BVP, EDA, HR, IBI and TEMP. It also includes a info.txt file explaining the data format and a tags.txt file specifying the events present in the data.

Parameters:

• session_id – numeric ID that identifies the session.
• file_path – path of the resulting output file.

remove_session(session_id: str)

Removes a session.

Parameters:session_id – numeric ID that identifies the session.

purchased_devices() → list

Retrieves a list of all the devices linked with the current session. It includes the following columns: device_id, label, model, hardware_code, purchase_code, purchase_id.

Returns:list of dictionaries with information of the devices.

user_id() → str

Retrieves the numeric identifier of the user.

Returns:user ID.