Energy

SCPI Commands

MEASure:SCALar:ENERgy:STATe
MEASure:SCALar:ENERgy:RESet
MEASure:SCALar:ENERgy
class EnergyCls[source]

Energy commands group definition. 3 total commands, 0 Subgroups, 3 group commands

get_state() bool[source]
# SCPI: MEASure[:SCALar]:ENERgy:STATe
value: bool = driver.measure.scalar.energy.get_state()

Sets or queries the energy counter state for the selected channel.

return

arg_0: No help available

get_value() float[source]
# SCPI: MEASure[:SCALar]:ENERgy
value: float = driver.measure.scalar.energy.get_value()

Queries the measured the current released energy value of the previous selected channel.

return

result: No help available

reset() None[source]
# SCPI: MEASure[:SCALar]:ENERgy:RESet
driver.measure.scalar.energy.reset()

Resets the energy counter for the selected channel.

reset_with_opc(opc_timeout_ms: int = -1) None[source]
# SCPI: MEASure[:SCALar]:ENERgy:RESet
driver.measure.scalar.energy.reset_with_opc()

Resets the energy counter for the selected channel.

Same as reset, but waits for the operation to complete before continuing further. Use the RsNgx.utilities.opc_timeout_set() to set the timeout value.

param opc_timeout_ms

Maximum time to wait in milliseconds, valid only for this call.

set_state(arg_0: bool) None[source]
# SCPI: MEASure[:SCALar]:ENERgy:STATe
driver.measure.scalar.energy.set_state(arg_0 = False)

Sets or queries the energy counter state for the selected channel.

param arg_0
  • 1: Activates the energy counter.

  • 0: Deactivates the energy counter.