For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
OverviewCodaControlAPI ReferenceChangelog
OverviewCodaControlAPI ReferenceChangelog
  • Coda API
  • Control API
  • Stanza API
    • stanza
      • base
      • channels
      • instruments
      • mixins
      • protocols
      • registry
    • cli
    • context
    • device
    • exceptions
    • models
    • pyvisa
    • registry
    • timing
    • utils
LogoLogo
On this page
  • Module Contents
  • Classes
  • API
Stanza APIbase

stanza.base.protocols

Was this page helpful?
Built with

Module Contents

Classes

NameDescription
BreakoutBoxInstrumentProtocol for a digital breakout box.
ControlInstrumentProtocol for control instruments.
MeasurementInstrumentProtocol for measurement instruments.
NamedResourceProtocol for resources that have a name attribute.

API

1class stanza.base.protocols.BreakoutBoxInstrument

Bases: typing.Protocol

Protocol for a digital breakout box.

1get_grounded(channel_name: str | list[str]) -> bool | list[bool]

Check if breakout box channel(s) are grounded.

1set_grounded(channel_name: str | list[str]) -> None

Set breakout box channel(s) to grounded.

1get_ungrounded(channel_name: str | list[str]) -> bool | list[bool]

Check if breakout box channel(s) are ungrounded.

1set_ungrounded(channel_name: str | list[str]) -> None

Set breakout box channel(s) to ungrounded.

1get_connected(
2 channel_name: str | list[str], line_number: int
3) -> bool | list[bool]

Get if breakout box channel(s) are connected to the line number.

1set_connected(
2 channel_name: str | list[str], line_number: int
3) -> None

Set breakout box channel(s) to connected to the line number.

1get_disconnected(
2 channel_name: str | list[str], line_number: int
3) -> bool | list[bool]

Get if breakout box channel(s) are disconnected from the line number.

1set_disconnected(
2 channel_name: str | list[str], line_number: int
3) -> None

Set breakout box channel(s) to disconnected from the line number.

1class stanza.base.protocols.ControlInstrument

Bases: typing.Protocol

Protocol for control instruments.

1set_voltage(
2 channel_name: str, voltage: float
3) -> None

Set the voltage on a specific channel.

1get_voltage(channel_name: str) -> float

Get the voltage on a specific channel.

1get_slew_rate(channel_name: str) -> float

Get the slew rate on a specific channel.

1class stanza.base.protocols.MeasurementInstrument

Bases: typing.Protocol

Protocol for measurement instruments.

1measure(channel_name: str | list[str]) -> float | list[float]

Measure the current on a specific channel(s).

1class stanza.base.protocols.NamedResource

Bases: typing.Protocol

Protocol for resources that have a name attribute.

1name: str

Value: None