`laboneq.dsl.device` ¶

`laboneq.dsl.device.device_setup` ¶

`DeviceSetup` `dataclass` ¶

Data object describing the device setup of a QCCS system.

`dumps()` ¶

`from_descriptor(yaml_text, server_host=None, server_port=None, setup_name=None)` `staticmethod` ¶

Construct the device setup from a YAML descriptor.

Parameters:

Name	Type	Description	Default
`yaml_text`	`str`	YAML file containing the device description.	required
`server_host`	`str`	Server host of the setup that should be created.	`None`
`server_port`	`str`	Port of the server that should be created.	`None`
`setup_name`	`str`	Name of the setup that should be created.	`None`

`from_dict(data, server_host=None, server_port=None, setup_name=None)` `classmethod` ¶

Construct the device setup from a Python dictionary.

Parameters:

Name	Type	Description	Default
`data`	`Dict[str, Any]`	Device setup data.	required
`server_host`	`Optional[str]`	Server host of the setup that should be created.	`None`
`server_port`	`Optional[Union[str, int]]`	Port of the server that should be created.	`None`
`setup_name`	`Optional[str]`	Name of the setup that should be created.	`None`

.. versionadded:: 2.5.0

`from_dicts(*, instrument_list=None, instruments=None, connections=None, dataservers=None, server_host=None, server_port=None, setup_name=None)` `staticmethod` ¶

Construct the device setup from Python dicts, same structure as yaml

Parameters:

Name	Type	Description	Default
`instrument_list`	`dict`	List of instruments in the setup (deprecated; for backwards compatibility)	`None`
`instruments`	`dict`	List of instruments in the setup	`None`
`connections`	`dict`	Connections between devices	`None`
`server_host`	`str`	Server host of the setup that should be created.	`None`
`server_port`	`str`	Port of the server that should be created.	`None`
`setup_name`	`str`	Name of the setup that should be created.	`None`

`from_yaml(filepath, server_host=None, server_port=None, setup_name=None)` `staticmethod` ¶

Construct the device setup from a YAML file.

Parameters:

Name	Type	Description	Default
`filepath`	`str`	Path to the YAML file containing the device description.	required
`server_host`	`str`	Server host of the setup that should be created.	`None`
`server_port`	`str`	Port of the server that should be created.	`None`
`setup_name`	`str`	Name of the setup that should be created.	`None`

`get_calibration(path=None)` ¶

Retrieve the calibration of a specific path.

Parameters:

Name	Type	Description	Default
`path`	`str`	Path of the calibration information.	`None`

Returns:

Name	Type	Description
`calibration`	`Calibration`	Calibration object of the device setup.

`instrument_by_uid(uid)` ¶

`list_calibratables()` ¶

`load(filename)` `staticmethod` ¶

Serialize the device setup into a specified filename.

Parameters:

Name	Type	Description	Default
`filename`	`str`	Filename.	required

`logical_signal_by_uid(uid)` ¶

Get logical signal by uid.

Parameters:

Name	Type	Description	Default
`uid`	`str`	UID of the signal.	required

Returns:

Type	Description
`LogicalSignal`	Logical signal with the UID.

Raises:

Type	Description
`KeyError`	Logical signal UID was not found.

.. versionadded:: 2.5.0

`reset_calibration(calibration=None)` ¶

Reset the calibration of all logical signals and instruments.

`save(filename)` ¶

Load the device setup from a specified filename.

Parameters:

Name	Type	Description	Default
`filename`	`str`	Filename.	required

`set_calibration(calibration)` ¶

Set the calibration of the device setup.

Parameters:

Name	Type	Description	Default
`calibration`	`Calibration`	Calibration object containing the keys of the individual settings.	required