EQ-99

Communicate with the EQ-99 Manager from Energetiq.

EQ99 (Serial)

EQ99(equipment: Equipment)

              flowchart LR
              msl.equipment_resources.energetiq.eq99.EQ99[EQ99]
              msl.equipment.interfaces.serial.Serial[Serial]
              msl.equipment.interfaces.message_based.MessageBased[MessageBased]
              msl.equipment.schema.Interface[Interface]

                              msl.equipment.interfaces.serial.Serial --> msl.equipment_resources.energetiq.eq99.EQ99
                                msl.equipment.interfaces.message_based.MessageBased --> msl.equipment.interfaces.serial.Serial
                                msl.equipment.schema.Interface --> msl.equipment.interfaces.message_based.MessageBased
                




              click msl.equipment_resources.energetiq.eq99.EQ99 href "" "msl.equipment_resources.energetiq.eq99.EQ99"
              click msl.equipment.interfaces.serial.Serial href "" "msl.equipment.interfaces.serial.Serial"
              click msl.equipment.interfaces.message_based.MessageBased href "" "msl.equipment.interfaces.message_based.MessageBased"
              click msl.equipment.schema.Interface href "" "msl.equipment.schema.Interface"
            

Communicate with the EQ-99 Manager from Energetiq.

Regular-expression patterns that are used to select this Resource when connect() is called.

manufacturer=r"Energetiq"
model=r"EQ-99(-MGR)?"
flags=IGNORECASE

Parameters:

Name	Type	Description	Default
equipment	Equipment	An Equipment instance.	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def __init__(self, equipment: Equipment) -> None:
    """Communicate with the EQ-99 Manager from Energetiq.

    Regular-expression patterns that are used to select this Resource when
    [connect()][msl.equipment.schema.Equipment.connect] is called.
    ```python
    manufacturer=r"Energetiq"
    model=r"EQ-99(-MGR)?"
    flags=IGNORECASE
    ```

    Args:
        equipment: An [Equipment][] instance.
    """
    assert equipment.connection is not None  # noqa: S101
    equipment.connection.properties.setdefault("baud_rate", 38400)
    super().__init__(equipment)
    self.rstrip: bool = True

condition_register

condition_register() -> int

Query the LDLS condition register.

The condition register reflects the state of the instrument at the time the condition register is read.

The bit-mask sequence is as follows:

Bit Index	Value	Description
0	1	Interlock
1	2	Controller not detected
2	4	Controller fault
3	8	Lamp fault
4	16	Output on
5	32	Lamp on
6	64	Laser on
7	128	Laser stable
8	256	Shutter open

Returns:

Type	Description
int	The condition register value.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def condition_register(self) -> int:
    """Query the LDLS condition register.

    The condition register reflects the state of the instrument
    at the time the condition register is read.

    The bit-mask sequence is as follows:

    | Bit Index | Value | Description             |
    | :-------: | :---: | :---------------------- |
    |   0       |    1  | Interlock               |
    |   1       |    2  | Controller not detected |
    |   2       |    4  | Controller fault        |
    |   3       |    8  | Lamp fault              |
    |   4       |   16  | Output on               |
    |   5       |   32  | Lamp on                 |
    |   6       |   64  | Laser on                |
    |   7       |  128  | Laser stable            |
    |   8       |  256  | Shutter open            |

    Returns:
        The condition register value.
    """
    return int(self.query("LDLS:COND?"))

delay

delay(milliseconds: int) -> None

Specify a delay to use in command processing.

Parameters:

Name	Type	Description	Default
milliseconds	int	Causes command processing to be delayed for the specified number of milliseconds. Valid range is from 1 to 30000 milliseconds.	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def delay(self, milliseconds: int) -> None:
    """Specify a delay to use in command processing.

    Args:
        milliseconds: Causes command processing to be delayed for the specified number
            of milliseconds. Valid range is from 1 to 30000 milliseconds.
    """
    if not (1 <= milliseconds <= MAX_TIME):
        msg = f"Invalid delay of {milliseconds} milliseconds, must be in the range [1, {MAX_TIME}]"
        raise ValueError(msg)
    self._write_check(f"DELAY {milliseconds}")

event_register

event_register() -> int

Query the LDLS event register.

Returns the LDLS event register. The event register reflects the occurrence of any condition since the last time the event register was read. For example, if the output was turned on and then turned off, the Output on the bit in the condition register will be zero, but the same bit in the event register will be one.

The bit-mask sequence is as follows:

Bit Index	Value	Description
0	1	Interlock
1	2	Controller not detected
2	4	Controller fault
3	8	Lamp fault
4	16	Output on
5	32	Lamp on
6	64	Laser on
7	128	Laser stable
8	256	Shutter open

Returns:

Type	Description
int	The event register value.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def event_register(self) -> int:
    """Query the LDLS event register.

    Returns the LDLS event register. The event register reflects the
    occurrence of any condition since the last time the event register
    was read. For example, if the output was turned on and then turned off,
    the Output on the bit in the condition register will be zero, but the
    same bit in the event register will be one.

    The bit-mask sequence is as follows:

    | Bit Index | Value | Description             |
    | :-------: | :---: | :---------------------- |
    |   0       |    1  | Interlock               |
    |   1       |    2  | Controller not detected |
    |   2       |    4  | Controller fault        |
    |   3       |    8  | Lamp fault              |
    |   4       |   16  | Output on               |
    |   5       |   32  | Lamp on                 |
    |   6       |   64  | Laser on                |
    |   7       |  128  | Laser stable            |
    |   8       |  256  | Shutter open            |

    Returns:
        The event register value.
    """
    return int(self.query("LDLS:EVENT?"))

get_beep

get_beep() -> bool

Query whether beeps are enabled.

Returns:

Type	Description
bool	Whether beeps are enabled.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_beep(self) -> bool:
    """Query whether beeps are enabled.

    Returns:
        Whether beeps are enabled.
    """
    return bool(int(self.query("BEEP?")))

get_brightness

get_brightness() -> int

Query the display brightness.

Returns:

Type	Description
int	Returns the value of the display brightness (between 0 and 100).

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_brightness(self) -> int:
    """Query the display brightness.

    Returns:
        Returns the value of the display brightness (between 0 and 100).
    """
    return int(self.query("BRIGHT?"))

get_exposure_mode

get_exposure_mode() -> int

Query the exposure mode.

Returns:

Type	Description
int	The exposure mode. 0 — Manual mode 1 — Exposure mode

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_exposure_mode(self) -> int:
    """Query the exposure mode.

    Returns:
        The exposure mode.

            * 0 — Manual mode
            * 1 — Exposure mode
    """
    return int(self.query("LDLS:EXPMODE?"))

get_exposure_time

get_exposure_time() -> int

Query the exposure time.

Returns:

Type	Description
int	The exposure time, in milliseconds.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_exposure_time(self) -> int:
    """Query the exposure time.

    Returns:
        The exposure time, in milliseconds.
    """
    return int(self.query("LDLS:EXPOSURE?"))

get_lamp_runtime

get_lamp_runtime() -> float

Query the lamp runtime.

Returns:

Type	Description
float	The number of hours accumulated while the lamp was on.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_lamp_runtime(self) -> float:
    """Query the lamp runtime.

    Returns:
        The number of hours accumulated while the lamp was on.
    """
    return float(self.query("LDLS:LAMPTIME?"))

get_message_buffer

get_message_buffer() -> str

Query the internal message buffer.

Returns:

Type	Description
str	The value of the internal message buffer.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_message_buffer(self) -> str:
    """Query the internal message buffer.

    Returns:
        The value of the internal message buffer.
    """
    return self.query("MESSAGE?")

get_output_state

get_output_state() -> bool

Query the output state.

Returns:

Type	Description
bool	Whether the output is enabled or disabled.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_output_state(self) -> bool:
    """Query the output state.

    Returns:
        Whether the output is enabled or disabled.
    """
    return bool(int(self.query("LDLS:OUTPUT?")))

get_remote_mode_error

get_remote_mode_error() -> bool

Query whether errors are displayed while in remote mode.

Returns:

Type	Description
bool	Whether errors are displayed while in remote mode.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_remote_mode_error(self) -> bool:
    """Query whether errors are displayed while in remote mode.

    Returns:
        Whether errors are displayed while in remote mode.
    """
    return bool(int(self.query("REMERR?")))

get_shutter_power_up_state

get_shutter_power_up_state() -> bool

Query the power-up shutter state.

Returns:

Type	Description
bool	The power-up shutter state. False — Shutter is closed on power-up True — Shutter is open on power-up

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_shutter_power_up_state(self) -> bool:
    """Query the power-up shutter state.

    Returns:
        The power-up shutter state.

            * `False` — Shutter is closed on power-up
            * `True` — Shutter is open on power-up
    """
    return bool(int(self.query("LDLS:SHUTINIT?")))

get_shutter_state

get_shutter_state() -> bool

Query the shutter state.

Returns:

Type	Description
bool	The state of the shutter. False — Shutter is closed True — Shutter is open

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_shutter_state(self) -> bool:
    """Query the shutter state.

    Returns:
        The state of the shutter.

            * `False` — Shutter is closed
            * `True` — Shutter is open
    """
    return bool(int(self.query("LDLS:SHUTTER?")))

get_termination

get_termination() -> int

Query response terminator.

Returns the current response terminator setting. See set_termination for possible return values.

Returns:

Type	Description
int	The response terminator.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_termination(self) -> int:
    """Query response terminator.

    Returns the current response terminator setting. See
    [set_termination][msl.equipment_resources.energetiq.eq99.EQ99.set_termination]
    for possible return values.

    Returns:
        The response terminator.
    """
    return int(self.query("TERM?"))

get_trigger_mode

get_trigger_mode() -> int

Query the trigger mode.

Returns:

Type	Description
int	The trigger mode. See set_trigger_mode for more details.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def get_trigger_mode(self) -> int:
    """Query the trigger mode.

    Returns:
        The trigger mode. See [set_trigger_mode][msl.equipment_resources.energetiq.eq99.EQ99.set_trigger_mode]
            for more details.
    """
    return int(self.query("LDLS:TRIGMODE?"))

identity

identity() -> str

Query the instrument identification.

Returns:

Type	Description
str	Returns the identification string for the instrument in the following format: Energetiq Model SN Ver Build

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def identity(self) -> str:
    """Query the instrument identification.

    Returns:
        Returns the identification string for the instrument in the following format:
            *Energetiq Model SN Ver Build*
    """
    return self.query("*IDN?")

reset

reset() -> None

Resets the instrument to factory defaults and the output is shut off.

The unit remains in remote mode.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def reset(self) -> None:
    """Resets the instrument to factory defaults and the output is shut off.

    The unit remains in remote mode.
    """
    _ = self._write_check("*RST")

serial_number

serial_number() -> str

Query the serial number of the instrument.

Returns:

Type	Description
str	The serial number of the instrument. This is the same information that is part of the *IDN? query.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def serial_number(self) -> str:
    """Query the serial number of the instrument.

    Returns:
        The serial number of the instrument. This is the same information that is part of the `*IDN?` query.
    """
    return self.query("SN?")

set_beep

set_beep(beep: bool | int = 2) -> None

Set the beep value.

Parameters:

Name	Type	Description	Default
beep	bool | int	Causes the instrument to beep, or enables or disabled the beep sound for error messages and other events that generate and audible response. 0 or False — Disable the beep sound 1 or True — Enable the beep sound 2 — Generate one beep	2

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_beep(self, beep: bool | int = 2) -> None:  # noqa: FBT001
    """Set the beep value.

    Args:
        beep: Causes the instrument to beep, or enables or disabled the beep
            sound for error messages and other events that generate and
            audible response.

            * 0 or `False` — Disable the beep sound
            * 1 or `True` — Enable the beep sound
            * 2 — Generate one beep
    """
    if beep not in [0, 1, 2, True, False]:
        msg = f"Invalid beep value '{beep}'"
        raise MSLConnectionError(self, msg)
    self._write_check(f"BEEP {beep}")

set_brightness

set_brightness(brightness: int) -> None

Set the display brightness.

Parameters:

Name	Type	Description	Default
brightness	int	Sets the display brightness level from 0 to 100 percent. There are only 8 brightness levels (each separated by about 12.5 percent) and the brightness value is used to select an appropriate level.	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_brightness(self, brightness: int) -> None:
    """Set the display brightness.

    Args:
        brightness: Sets the display brightness level from 0 to 100 percent.
            There are only 8 brightness levels (each separated by about
            12.5 percent) and the brightness value is used to select an
            appropriate level.
    """
    self._write_check(f"BRIGHT {int(brightness)}")

set_exposure_mode

set_exposure_mode(mode: int) -> None

Set the exposure mode.

Same as the Shutter setting in the menu.

Parameters:

Name	Type	Description	Default
mode	int	The exposure mode. 0 — Manual mode 1 — Exposure mode	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_exposure_mode(self, mode: int) -> None:
    """Set the exposure mode.

    Same as the *Shutter* setting in the menu.

    Args:
        mode: The exposure mode.

            * 0 — Manual mode
            * 1 — Exposure mode
    """
    self._write_check(f"LDLS:EXPMODE {mode}")

set_exposure_time

set_exposure_time(milliseconds: int) -> None

Set the exposure time.

Exposure time is used when the shutter exposure mode is set to Exposure mode (see set_exposure_mode). An exposure is triggered by a shutter button press or the shutter trigger input.

Parameters:

Name	Type	Description	Default
milliseconds	int	The exposure time, in milliseconds, from 100 to 30000 ms.	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_exposure_time(self, milliseconds: int) -> None:
    """Set the exposure time.

    Exposure time is used when the shutter exposure mode is set to `Exposure mode`
    (see [set_exposure_mode][msl.equipment_resources.energetiq.eq99.EQ99.set_exposure_mode]).
    An exposure is triggered by a shutter button press or the shutter trigger input.

    Args:
        milliseconds: The exposure time, in milliseconds, from 100 to 30000 ms.
    """
    if not (MIN_EXPOSURE_TIME <= milliseconds <= MAX_TIME):
        msg = (
            f"Invalid exposure time of {milliseconds} milliseconds, "
            f"must be in the range [{MIN_EXPOSURE_TIME}, {MAX_TIME}]"
        )
        raise ValueError(msg)
    self._write_check(f"LDLS:EXPOSURE {milliseconds}")

set_lamp_runtime

set_lamp_runtime(hours: float) -> None

Set the lamp runtime.

Resets the runtime to the new value. Useful for resetting the runtime to zero when the lamp has been serviced or replaced, or when moving the manager to a new LDLS system.

Parameters:

Name	Type	Description	Default
hours	float	The lamp runtime, in hours, between 0 and 9999.	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_lamp_runtime(self, hours: float) -> None:
    """Set the lamp runtime.

    Resets the runtime to the new value. Useful for resetting the runtime
    to zero when the lamp has been serviced or replaced, or when moving
    the manager to a new LDLS system.

    Args:
        hours: The lamp runtime, in hours, between 0 and 9999.
    """
    if not (0 <= hours <= MAX_RUNTIME):
        msg = f"Invalid lamp runtime of {hours} hours, must be in the range [0, {MAX_RUNTIME}]"
        raise ValueError(msg)
    self._write_check(f"LDLS:LAMPTIME {hours}")

set_message_buffer

set_message_buffer(message: str) -> None

Set the message buffer.

Parameters:

Name	Type	Description	Default
message	str	Sets the internal message buffer, up to a maximum of 16 characters. If more than 16 characters are specified then the additional characters are silently ignored.	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_message_buffer(self, message: str) -> None:
    """Set the message buffer.

    Args:
        message: Sets the internal message buffer, up to a maximum of 16 characters. If more than
            16 characters are specified then the additional characters are silently ignored.
    """
    self._write_check(f"MESSAGE {message}")

set_output_state

set_output_state(enable: bool) -> None

Turn the output on or off.

Parameters:

Name	Type	Description	Default
enable	bool	Whether to enable or disable the output.	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_output_state(self, enable: bool) -> None:  # noqa: FBT001
    """Turn the output on or off.

    Args:
        enable: Whether to enable or disable the output.
    """
    self._write_check(f"LDLS:OUTPUT {enable}")

set_remote_mode_error

set_remote_mode_error(enable: bool | int) -> None

Set whether to display errors while in remote mode.

This command controls if the instrument will display errors while in remote mode. If set to 0/False, then errors will not be displayed. If set to 1/True, errors will be displayed. Errors will always accumulate in the error queue.

Parameters:

Name	Type	Description	Default
enable	bool | int	Whether to display errors while in remote mode. 0 or False — Do not display errors in remote mode 1 or True — Display errors in remote mode	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_remote_mode_error(self, enable: bool | int) -> None:  # noqa: FBT001
    """Set whether to display errors while in remote mode.

    This command controls if the instrument will display errors while in
    remote mode. If set to `0`/`False`, then errors will not be displayed. If
    set to `1`/`True`, errors will be displayed. Errors will always accumulate
    in the error queue.

    Args:
        enable: Whether to display errors while in remote mode.

            * 0 or `False` — Do not display errors in remote mode
            * 1 or `True` — Display errors in remote mode
    """
    self._write_check(f"REMERR {enable}")

set_shutter_power_up_state

set_shutter_power_up_state(state: bool) -> None

Set the power-up shutter state.

Parameters:

Name	Type	Description	Default
state	bool	Sets the initial state of the shutter on power-up of the manager. False — Shutter is closed on power-up True — Shutter is open on power-up	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_shutter_power_up_state(self, state: bool) -> None:  # noqa: FBT001
    """Set the power-up shutter state.

    Args:
        state: Sets the initial state of the shutter on power-up of the manager.

            * `False` — Shutter is closed on power-up
            * `True` — Shutter is open on power-up
    """
    self._write_check(f"LDLS:SHUTINIT {state}")

set_shutter_state

set_shutter_state(state: bool) -> None

Open, close, or trigger the shutter.

A close command (state is False) will always close the shutter, regardless of exposure mode. An open command (state is True) will open the shutter if exposure mode is set to Manual, or trigger a shutter if exposure mode is set to Exposure.

Parameters:

Name	Type	Description	Default
state	bool	The state of the shutter. False — Close the shutter True — Open or trigger the shutter	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_shutter_state(self, state: bool) -> None:  # noqa: FBT001
    """Open, close, or trigger the shutter.

    A close command (state is `False`) will always close the shutter,
    regardless of exposure mode. An open command (state is `True`)
    will open the shutter if exposure mode is set to *Manual*, or
    trigger a shutter if exposure mode is set to *Exposure*.

    Args:
        state: The state of the shutter.

            * `False` — Close the shutter
            * `True` — Open or trigger the shutter
    """
    self._write_check(f"LDLS:SHUTTER {state}")

set_termination

set_termination(value: int) -> None

Set the response terminator character(s).

This command controls the termination characters used for responses to queries.

Parameters:

Name	Type	Description	Default
value	int	The response terminator character(s). 0 or 1 — <CR><LF> 2 or 3 — <CR> 4 or 5 — <LF> 6 or 7 — no terminator	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_termination(self, value: int) -> None:
    """Set the response terminator character(s).

    This command controls the termination characters used for
    responses to queries.

    Args:
        value: The response terminator character(s).

            * 0 or 1 &mdash; `<CR><LF>`
            * 2 or 3 &mdash; `<CR>`
            * 4 or 5 &mdash; `<LF>`
            * 6 or 7 &mdash; no terminator
    """
    self._write_check(f"TERM {value}")

set_trigger_mode

set_trigger_mode(mode: int) -> None

Set the trigger mode.

The trigger mode controls how the shutter trigger input controls the operation of the shutter. For more information on trigger modes, see Shutter Operation in the Operating the Instrument section of the manual for more details.

Parameters:

Name	Type	Description	Default
mode	int	The trigger mode. 0 — Positive edge trigger 1 — Negative edge trigger 2 — Positive level trigger 3 — Negative level trigger 4 — Off (trigger disabled)	required

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def set_trigger_mode(self, mode: int) -> None:
    """Set the trigger mode.

    The trigger mode controls how the shutter trigger input controls the
    operation of the shutter. For more information on trigger modes, see
    *Shutter Operation* in the *Operating the Instrument* section of the
    manual for more details.

    Args:
        mode: The trigger mode.

            * 0 — Positive edge trigger
            * 1 — Negative edge trigger
            * 2 — Positive level trigger
            * 3 — Negative level trigger
            * 4 — Off (trigger disabled)
    """
    self._write_check(f"LDLS:TRIGMODE {mode}")

timer

timer() -> str

Query the elapsed time since the last time this method was called.

Returns:

Type	Description
str	Returns the elapsed time since the last time this method was called, or, if this is the first time calling this method then the time since unit has been turned on. Format is in HH:MM:SS.ss, where HH is hours, MM is minutes, SS is seconds, and ss is hundredths of a second.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def timer(self) -> str:
    """Query the elapsed time since the last time this method was called.

    Returns:
        Returns the elapsed time since the last time this method was
            called, or, if this is the first time calling this method
            then the time since unit has been turned on. Format is in
            HH:MM:SS.ss, where HH is hours, MM is minutes, SS is seconds,
            and ss is hundredths of a second.
    """
    return self.query("TIMER?")

unit_runtime

unit_runtime() -> str

Query unit run time.

Returns:

Type	Description
str	Returns the elapsed time since the unit has been turned on. Format is in HH:MM:SS.ss, where HH is hours, MM is minutes, SS is seconds, and ss is hundredths of a second.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def unit_runtime(self) -> str:
    """Query unit run time.

    Returns:
        Returns the elapsed time since the unit has been turned on.
            Format is in HH:MM:SS.ss, where HH is hours, MM is minutes,
            SS is seconds, and ss is hundredths of a second.
    """
    return self.query("TIME?")

version

version() -> str

Query the firmware version.

Returns:

Type	Description
str	Returns the firmware version. This is the same information that is part of the *IDN? query.

Source code in packages/resources/src/msl/equipment_resources/energetiq/eq99.py

def version(self) -> str:
    """Query the firmware version.

    Returns:
        Returns the firmware version. This is the same information that is part of the `*IDN?` query.
    """
    return self.query("VER?")