util module

check_response_errors

edgeimpulse.util.check_response_errors(
		request
)

Check for standard errors and raise an exception with the details if found.

Parameters

• request

configure_generic_client

edgeimpulse.util.configure_generic_client(
		key: str,
		key_type: Optional[str] = 'api',
		host: Optional[str] = 'https://studio.edgeimpulse.com/v1'
) ‑> edgeimpulse_api.api_client.ApiClient

Configure generic api client which the right key.

Parameters

• key: str

• key_type: Optional[str] = 'api'

• host: Optional[str] = 'https://studio.edgeimpulse.com/v1'

Return

edgeimpulse_api.api_client.ApiClient

connect_websocket

edgeimpulse.util.connect_websocket(
		token,
		host: str = None
) ‑> socketio.client.Client

Connects to the websocket server.

Parameters: token (str): The authentication token. host (str, optional): The hostname. If None, API_ENDPOINT will be used.

Returns: object: Websocket object.

Parameters

• token

• host: str = None

Return

socketio.client.Client