MDR69xB Channel

From: Thorlabs

Class: herosdevices.hardware.thorlabs.mdt69xb.MDT69xBChannel

Driver Quality Index: beta

A single channel of a MDT69xB piezo driver.

This class provides an herosdevices.interfaces.atomiq.VoltageSource compatible interface to control a single channel of a MDT69xB piezo driver.

Note

This class does not directly connect to the hardware but to another object given by the host_device argument which can also be a HERO running on another machine. It can be used to provide a universal interface which does not require setting a channel for every operation.

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

Argument

Type

Default Value

Description

host_device

herosdevices.hardware.thorlabs.mdt69xb.MDT693B | herosdevices.hardware.thorlabs.mdt69xb.MDT694B

The host MDT69xB device (MDT693B or MDT694B).

channel

int | str

x

The channel to control (can be int 0-2 or str ‘x’, ‘y’, ‘z’, depending on host_device)

The following JSON strings can be used to start a HERO device representation of MDT69xBChannel using BOSS.

{
    "_id": "my-piezo-channel",
    "classname": "herosdevices.hardware.thorlabs.MDT69xBChannel",
    "arguments": {
        "host_device": "$my-3channel-piezo-controller",
        "channel": 1
    }
}

Note

This example contains a variable that references another HERO with $.

from examples/thorlabs/mdt69xb.json

{
    "_id": "my_MDT69xBChannel",
    "classname": "herosdevices.hardware.thorlabs.mdt69xb.MDT69xBChannel",
    "arguments": {
        "host_device": "herosdevices.hardware.thorlabs.mdt69xb.MDT693B | herosdevices.hardware.thorlabs.mdt69xb.MDT694B",
        "channel": "x"
    }
}

generated from signature

digraph inheritance00d057b114 { bgcolor=transparent; rankdir=TB; size=""; "herosdevices.hardware.thorlabs.mdt69xb.MDT69xBChannel" [URL="../../../autoapi/herosdevices/hardware/thorlabs/mdt69xb/index.html#herosdevices.hardware.thorlabs.mdt69xb.MDT69xBChannel",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="A single channel of a MDT69xB piezo driver."]; "herosdevices.interfaces.atomiq.VoltageSource" -> "herosdevices.hardware.thorlabs.mdt69xb.MDT69xBChannel" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; "herosdevices.interfaces.Interface" [URL="../../../autoapi/herosdevices/interfaces/index.html#herosdevices.interfaces.Interface",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="Generic Interface to describe and check capabilities of a device driver."]; "herosdevices.interfaces.atomiq.AtomiqInterface" [URL="../../../autoapi/herosdevices/interfaces/atomiq/index.html#herosdevices.interfaces.atomiq.AtomiqInterface",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="This interface defines the necessary methods for a HERO to seamlessly being converted into an atomiq component."]; "herosdevices.interfaces.Interface" -> "herosdevices.interfaces.atomiq.AtomiqInterface" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; "herosdevices.interfaces.atomiq.Parametrizable" [URL="../../../autoapi/herosdevices/interfaces/atomiq/index.html#herosdevices.interfaces.atomiq.Parametrizable",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="HERO implementation of :external+atomiq:py:class:`atomiq.components.primitives.Parametrizable`."]; "herosdevices.interfaces.atomiq.AtomiqInterface" -> "herosdevices.interfaces.atomiq.Parametrizable" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; "herosdevices.interfaces.atomiq.VoltageSource" [URL="../../../autoapi/herosdevices/interfaces/atomiq/index.html#herosdevices.interfaces.atomiq.VoltageSource",color="#5fabe8",fillcolor="#5fabe827",fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,penwidth=2,shape=box,style="rounded,filled",target="_top",tooltip="HERO implementation of :external+atomiq:py:class:`atomiq.components.electronics.voltagesource.VoltageSource`."]; "herosdevices.interfaces.atomiq.Parametrizable" -> "herosdevices.interfaces.atomiq.VoltageSource" [arrowsize=1,color="#5fabe8",dir="back",penwidth=2,style="setlinewidth(0.5)"]; }