Model

SCPI Commands

BATTery:MODel:SAVE
BATTery:MODel:LOAD
BATTery:MODel:TRANsfer
BATTery:MODel:CAPacity
BATTery:MODel:ISOC
BATTery:MODel:CLEar

class ModelCls

Model commands group definition. 11 total commands, 3 Subgroups, 6 group commands

clear() → None

# SCPI: BATTery:MODel:CLEar
driver.battery.model.clear()

Clears the current battery model.

clear_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: BATTery:MODel:CLEar
driver.battery.model.clear_with_opc()

Clears the current battery model.

Same as clear, 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.

get_capacity() → float

# SCPI: BATTery:MODel:CAPacity
value: float = driver.battery.model.get_capacity()

Sets or queries the battery model capacity.

return

arg_0: Sets the battery model capacity.

get_isoc() → float

# SCPI: BATTery:MODel:ISOC
value: float = driver.battery.model.get_isoc()

Sets or queries the initial state of charge (SoC) of the battery model.

return

arg_0: No help available

load() → None

# SCPI: BATTery:MODel:LOAD
driver.battery.model.load()

Loads a battery model for editing.

load_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: BATTery:MODel:LOAD
driver.battery.model.load_with_opc()

Loads a battery model for editing.

Same as load, 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.

save() → None

# SCPI: BATTery:MODel:SAVE
driver.battery.model.save()

Saves the current battery model to a file

save_with_opc(opc_timeout_ms: int = -1) → None

# SCPI: BATTery:MODel:SAVE
driver.battery.model.save_with_opc()

Saves the current battery model to a file

Same as save, 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_capacity(arg_0: float) → None

# SCPI: BATTery:MODel:CAPacity
driver.battery.model.set_capacity(arg_0 = 1.0)

Sets or queries the battery model capacity.

param arg_0

Sets the battery model capacity.

set_isoc(arg_0: float) → None

# SCPI: BATTery:MODel:ISOC
driver.battery.model.set_isoc(arg_0 = 1.0)

Sets or queries the initial state of charge (SoC) of the battery model.

param arg_0

Initial state of charge (SoC) for the battery model.

set_transfer(arg_0: int) → None

# SCPI: BATTery:MODel:TRANsfer
driver.battery.model.set_transfer(arg_0 = 1)

Transfers the loaded battery model into the channel.

param arg_0

1 | 2

Subgroups

• Current
  • Limit
• Data
• Fname