RemoteΒΆ

Class Arguments

Argument

Type

Default Value

remote_reference

str

sync

bool

False

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Inheritance diagram of atomiq.components.primitives.Remote

Example Component Dictionary

   {
    "primitives_example": {
        "classname": "atomiq.components.primitives.Remote",
        "arguments": {
            "remote_reference": "<mandatory parameter (str)>",
            "sync": false
        }
    }
}

Class Description

class atomiq.components.primitives.Remote(remote_reference, sync=False)[source]

Bases: object

An abstract class to represent a remote device, i.e. a device that ist not directly attached to the realtime control system (ARTIQ) but is rather controlled through a non-realtime link (i.e. HEROS, pyon, pyro, etc.)

Parameters:
  • remote_reference (str) -- A reference to the remote site that can handle the component. E.g. URL, IP, port, UID..

  • sync (bool) -- Is synchronous operation required, i.e. do we need to wait for the response of the remote site?