API reference

This page provides an auto-generated summary of Acconeer Exploration Tool’s API.

class acconeer.exptool.clients.base.BaseClient(**kwargs)
connect()

Initiates a connection with the device.

Returns:A dict containing information about the device, including SDK version
Return type:dict
setup_session(config, check_config=True)

Sets up a session with the given config. Will call connect() if not already connected.

Parameters:
  • config (class:acconeer.exptool.configs) – The configuration to use when setting up the session
  • check_config (bool) – If True the configuration is checked for errors, defaults to True
Returns:

A dict with metadata for the configured session

Return type:

dict

start_session(config=None, check_config=True)

Starts the session if previously set up with setup_session(). If config is provided, setup_session() will be called.

Parameters:
  • config (class:acconeer.exptool.configs, optional) – The configuration to use when setting up the session, defaults to None
  • check_config (bool) – If True the configuration is checked for errors, defaults to True
Returns:

If config is provided, returns a dict with metadata for the configured session. Otherwise, returns None

Return type:

dict or None

get_next()

Retrieves the next result. Will block until the result is received.

Returns:A tuple with the result info and data. The data shape and type differs between services.
Power Bins:
Shape: (number of sensors, bin count)
Type: float64
Envelope:
Shape: (number of sensors, data length)
Type: float64
IQ:
Shape: (number of sensors, data length)
Type: complex128
Sparse:
Shape: (number of sensors, number of sweeps, number of dephts)
Type: float64

Number of sensors, bin count and number of sweeps can be explicitly set. Data length and number of dephts depend on multiple configuration settings.

The client takes a parameter squeeze, if set to True the first dimension (number of sensors) is removed when using a single sensor. As default squeeze is True.

Return type:tuple[union[list, dict], np.ndarray]
stop_session()

Stops the session. All buffered/waiting data is thrown away. This function will block until the server has confirmed that the session has ended.

disconnect()

Disconnects the client. disconnect() will call stop_session() if a session is started.