[python source code]

psu

The psu commands module.

These commands are used in the following models: MPSU50_2ST

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions 
- psu[X].abort()
- psu[X].configlist.create()
- psu[X].configlist.delete()
- psu[X].configlist.query()
- psu[X].configlist.recall()
- psu[X].configlist.size()
- psu[X].configlist.store()
- psu[X].configlist.table()
- psu[X].defbuffer1
- psu[X].defbuffer2
- psu[X].makebuffer()
- psu[X].measure.aperture
- psu[X].measure.count
- psu[X].measure.i()
- psu[X].measure.nplc
- psu[X].measure.overlappedi()
- psu[X].measure.overlappediv()
- psu[X].measure.overlappedp()
- psu[X].measure.overlappedr()
- psu[X].measure.overlappedv()
- psu[X].measure.p()
- psu[X].measure.r()
- psu[X].measure.rangei
- psu[X].measure.rangev
- psu[X].measure.rate
- psu[X].measure.rel.enablei
- psu[X].measure.rel.enablep
- psu[X].measure.rel.enabler
- psu[X].measure.rel.enablev
- psu[X].measure.rel.leveli
- psu[X].measure.rel.levelp
- psu[X].measure.rel.levelr
- psu[X].measure.rel.levelv
- psu[X].measure.tempcomp
- psu[X].measure.v()
- psu[X].overlapped
- psu[X].reset()
- psu[X].source.constantcurrent
- psu[X].source.levelv
- psu[X].source.limiti
- psu[X].source.offmode
- psu[X].source.output
- psu[X].source.protect.enablei
- psu[X].source.protect.enablev
- psu[X].source.protect.leveli
- psu[X].source.protect.levelv
- psu[X].source.protect.trippedi
- psu[X].source.protect.trippedv
- psu[X].source.rangev
- psu[X].source.slewratev
- psu[X].trigger.measure.i()
- psu[X].trigger.measure.iv()
- psu[X].trigger.measure.p()
- psu[X].trigger.measure.r()
- psu[X].trigger.measure.v()
- psu[X].trigger.source.linearv()
- psu[X].trigger.source.listv()
- psu[X].trigger.source.logv()
- psu[X].waitcomplete()

PsuItem

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The psu[X] command tree.

Info
  • X, the module channel number.
Properties and methods
  • .abort(): The psu[X].abort() function.
  • .configlist: The psu[X].configlist command tree.
  • .defbuffer1: The psu[X].defbuffer1 attribute.
  • .defbuffer2: The psu[X].defbuffer2 attribute.
  • .makebuffer(): The psu[X].makebuffer() function.
  • .measure: The psu[X].measure command tree.
  • .overlapped: The psu[X].overlapped attribute.
  • .reset(): The psu[X].reset() function.
  • .source: The psu[X].source command tree.
  • .trigger: The psu[X].trigger command tree.
  • .waitcomplete(): The psu[X].waitcomplete() function.

configlist property 

configlist: PsuItemConfiglist

Return the psu[X].configlist command tree.

Info
  • X, the module channel number.
Sub-properties and sub-methods
  • .create(): The psu[X].configlist.create() function.
  • .delete(): The psu[X].configlist.delete() function.
  • .query(): The psu[X].configlist.query() function.
  • .recall(): The psu[X].configlist.recall() function.
  • .size(): The psu[X].configlist.size() function.
  • .store(): The psu[X].configlist.store() function.
  • .table(): The psu[X].configlist.table() function.

defbuffer1 cached property 

defbuffer1: Buffervar

Access the psu[X].defbuffer1 attribute.

Description
  • This attribute contains the default dedicated reading buffers. (1 = default buffer1)
Usage
  • Accessing this property will send the print(psu[X].defbuffer1) query.
TSP Syntax 
- print(psu[X].defbuffer1)
Returns:
Raises:

defbuffer2 cached property 

defbuffer2: Buffervar

Access the psu[X].defbuffer2 attribute.

Description
  • This attribute contains the default dedicated reading buffers. (2 = default buffer2)
Usage
  • Accessing this property will send the print(psu[X].defbuffer2) query.
TSP Syntax 
- print(psu[X].defbuffer2)
Returns:
Raises:

measure property 

measure: PsuItemMeasure

Return the psu[X].measure command tree.

Sub-properties and sub-methods
  • .i(): The psu[X].measure.i() function.
  • .p(): The psu[X].measure.p() function.
  • .r(): The psu[X].measure.r() function.
  • .v(): The psu[X].measure.v() function.
  • .aperture: The psu[X].measure.aperture attribute.
  • .count: The psu[X].measure.count attribute.
  • .nplc: The psu[X].measure.nplc attribute.
  • .overlappedi(): The psu[X].measure.overlappedi() function.
  • .overlappediv(): The psu[X].measure.overlappediv() function.
  • .overlappedp(): The psu[X].measure.overlappedp() function.
  • .overlappedr(): The psu[X].measure.overlappedr() function.
  • .overlappedv(): The psu[X].measure.overlappedv() function.
  • .rangei: The psu[X].measure.rangei attribute.
  • .rangev: The psu[X].measure.rangev attribute.
  • .rate: The psu[X].measure.rate attribute.
  • .rel: The psu[X].measure.rel command tree.
  • .tempcomp: The psu[X].measure.tempcomp attribute.

overlapped property writable 

overlapped: str

Access the psu[X].overlapped attribute.

Description
  • This attribute contains the state of the overlapped mode.
Usage
  • Accessing this property will send the print(psu[X].overlapped) query.
  • Setting this property to a value will send the psu[X].overlapped = value command.
TSP Syntax 
- psu[X].overlapped = value
- print(psu[X].overlapped)
Raises:

source property 

source: PsuItemSource

Return the psu[X].source command tree.

Info
  • X, the module channel number.
Sub-properties and sub-methods
  • .constantcurrent: The psu[X].source.constantcurrent attribute.
  • .levelv: The psu[X].source.levelv attribute.
  • .limiti: The psu[X].source.limiti attribute.
  • .offmode: The psu[X].source.offmode attribute.
  • .output: The psu[X].source.output attribute.
  • .protect: The psu[X].source.protect command tree.
  • .rangev: The psu[X].source.rangev attribute.
  • .slewratev: The psu[X].source.slewratev attribute.

trigger property 

trigger: PsuItemTrigger

Return the psu[X].trigger command tree.

Sub-properties and sub-methods
  • .measure: The psu[X].trigger.measure command tree.
  • .source: The psu[X].trigger.source command tree.

abort 

abort() -> None

Run the psu[X].abort() function.

Description
  • This function terminates all overlapped operations on the specified channel.
TSP Syntax 
- psu[X].abort()
Info
  • X, the module channel number.
Raises:

makebuffer 

makebuffer(buffer_size: str, *, buffer_name: str | None = None) -> Buffervar

Run the psu[X].makebuffer() function.

Description
  • This function creates a reading buffer.
TSP Syntax 
- psu[X].makebuffer()
Parameters:
  • buffer_size (str) –

    The size of the reading buffer.

  • buffer_name (optional, default: None ) –

    The name of the buffer variable to create. If not provided, an auto-generated variable will be used.
Returns:
Raises:

reset 

reset() -> None

Run the psu[X].reset() function.

Description
  • This function turns off the output and resets the commands that begin with psu[X]. to their default settings.
TSP Syntax 
- psu[X].reset()
Info
  • X, the module channel number.
Raises:

waitcomplete 

waitcomplete() -> None

Run the psu[X].waitcomplete() function.

Description
  • This function waits for all previously started overlapped commands to complete on the specified channel of a module.
TSP Syntax 
- psu[X].waitcomplete()
Info
  • X, the module channel number.
Raises:

PsuItemConfiglist

Bases: BaseTSPCmd

The psu[X].configlist command tree.

Info
  • X, the module channel number.
Properties and methods
  • .create(): The psu[X].configlist.create() function.
  • .delete(): The psu[X].configlist.delete() function.
  • .query(): The psu[X].configlist.query() function.
  • .recall(): The psu[X].configlist.recall() function.
  • .size(): The psu[X].configlist.size() function.
  • .store(): The psu[X].configlist.store() function.
  • .table(): The psu[X].configlist.table() function.

create 

create(config_list_name: str) -> None

Run the psu[X].configlist.create() function.

Description
  • This function creates an empty configuration list.
TSP Syntax 
- psu[X].configlist.create()
Parameters:
  • config_list_name (str) –

    A string that represents the name of a configuration list.
Raises:

delete 

delete(config_list_name: str, index: int | None = None) -> None

Run the psu[X].configlist.delete() function.

Description
  • This function deletes a configuration list.
TSP Syntax 
- psu[X].configlist.delete()
Parameters:
  • config_list_name (str) –

    A string that represents the name of a configuration list.

  • index (optional, default: None ) –

    A number starting from 1 that defines a specific configuration index in the configuration list.
Raises:

query 

query(config_list_name: str, index: int, field_separator: str | None = None) -> str

Run the psu[X].configlist.query() function.

Description
  • This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.
TSP Syntax 
- psu[X].configlist.query()
Parameters:
  • config_list_name (str) –

    A string that represents the name of a measure configuration list.

  • index (int) –

    A number starting from 1 that defines a specific configuration index in the configuration list.

  • field_separator (optional, default: None ) –

    String that represents the separator for the data; use one of the following.
Returns:
  • str –

    The result of the function call.
Raises:

recall 

recall(config_list_name: str, index: int) -> None

Run the psu[X].configlist.recall() function.

Description
  • This function recalls a configuration index in a configuration list.
TSP Syntax 
- psu[X].configlist.recall()
Parameters:
  • config_list_name (str) –

    A string that represents the name of a configuration list.

  • index (int) –

    A number starting from 1 that defines a specific configuration index in the measure configuration list.
Raises:

size 

size(config_list_name: str) -> str

Run the psu[X].configlist.size() function.

Description
  • This function returns the size (number of configuration indexes) of a configuration list.
TSP Syntax 
- psu[X].configlist.size()
Parameters:
  • config_list_name (str) –

    A string that represents the name of a configuration list.
Returns:
  • str –

    The result of the function call.
Raises:

store 

store(config_list_name: str, index: int | None = None) -> None

Run the psu[X].configlist.store() function.

Description
  • This function stores the active settings into the named configuration list.
TSP Syntax 
- psu[X].configlist.store()
Parameters:
  • config_list_name (str) –

    A string that represents the name of a configuration list.

  • index (optional, default: None ) –

    A number starting from 1 that defines a specific configuration index in the configuration list. This parameter is optional.
Raises:

table 

table() -> str

Run the psu[X].configlist.table() function.

Description
  • This function returns the name of one measure configuration lists that is stored on the instrument.
TSP Syntax 
- psu[X].configlist.table()
Info
  • X, the module channel number.
Returns:
  • str –

    The result of the function call.
Raises:

PsuItemMeasure

Bases: BaseTSPCmd

The psu[X].measure command tree.

Properties and methods
  • .i(): The psu[X].measure.i() function.
  • .p(): The psu[X].measure.p() function.
  • .r(): The psu[X].measure.r() function.
  • .v(): The psu[X].measure.v() function.
  • .aperture: The psu[X].measure.aperture attribute.
  • .count: The psu[X].measure.count attribute.
  • .nplc: The psu[X].measure.nplc attribute.
  • .overlappedi(): The psu[X].measure.overlappedi() function.
  • .overlappediv(): The psu[X].measure.overlappediv() function.
  • .overlappedp(): The psu[X].measure.overlappedp() function.
  • .overlappedr(): The psu[X].measure.overlappedr() function.
  • .overlappedv(): The psu[X].measure.overlappedv() function.
  • .rangei: The psu[X].measure.rangei attribute.
  • .rangev: The psu[X].measure.rangev attribute.
  • .rate: The psu[X].measure.rate attribute.
  • .rel: The psu[X].measure.rel command tree.
  • .tempcomp: The psu[X].measure.tempcomp attribute.

aperture property 

aperture: str

Access the psu[X].measure.aperture attribute.

Description
  • This attribute configures the measurement aperture for a channel in seconds.
Usage
  • Accessing this property will send the print(psu[X].measure.aperture) query.
TSP Syntax 
- print(psu[X].measure.aperture)
Info
  • X, the module channel number.
Raises:

count property writable 

count: str

Access the psu[X].measure.count attribute.

Description
  • This attribute sets the number of measurements performed when a measurement is requested.
Usage
  • Accessing this property will send the print(psu[X].measure.count) query.
  • Setting this property to a value will send the psu[X].measure.count = value command.
TSP Syntax 
- psu[X].measure.count = value
- print(psu[X].measure.count)
Info
  • X, the module channel number.
Raises:

nplc property 

nplc: str

Access the psu[X].measure.nplc attribute.

Description
  • This attribute configures the measurement aperture in number of power line cycles.
Usage
  • Accessing this property will send the print(psu[X].measure.nplc) query.
TSP Syntax 
- print(psu[X].measure.nplc)
Info
  • X, the module channel number.
Raises:

rangei property 

rangei: str

Access the psu[X].measure.rangei attribute.

Description
  • This attribute contains the positive, full scale value of the measurement range for voltage or current. (i = current in amperes)
Usage
  • Accessing this property will send the print(psu[X].measure.rangei) query.
TSP Syntax 
- print(psu[X].measure.rangei)
Raises:

rangev property 

rangev: str

Access the psu[X].measure.rangev attribute.

Description
  • This attribute contains the positive, full scale value of the measurement range for voltage or current. (v = voltage in volts)
Usage
  • Accessing this property will send the print(psu[X].measure.rangev) query.
TSP Syntax 
- print(psu[X].measure.rangev)
Raises:

rate property writable 

rate: str

Access the psu[X].measure.rate attribute.

Description
  • This attribute configures the measure rate for a PSU channel.
Usage
  • Accessing this property will send the print(psu[X].measure.rate) query.
  • Setting this property to a value will send the psu[X].measure.rate = value command.
TSP Syntax 
- psu[X].measure.rate = value
- print(psu[X].measure.rate)
Info
  • X, the module channel number.
Raises:

rel property 

rel: PsuItemMeasureRel

Return the psu[X].measure.rel command tree.

Sub-properties and sub-methods
  • .enablei: The psu[X].measure.rel.enablei attribute.
  • .enablep: The psu[X].measure.rel.enablep attribute.
  • .enabler: The psu[X].measure.rel.enabler attribute.
  • .enablev: The psu[X].measure.rel.enablev attribute.
  • .leveli: The psu[X].measure.rel.leveli attribute.
  • .levelp: The psu[X].measure.rel.levelp attribute.
  • .levelr: The psu[X].measure.rel.levelr attribute.
  • .levelv: The psu[X].measure.rel.levelv attribute.

tempcomp property writable 

tempcomp: str

Access the psu[X].measure.tempcomp attribute.

Description
  • This attribute turns temperature compensation on or off for the current measurements.
Usage
  • Accessing this property will send the print(psu[X].measure.tempcomp) query.
  • Setting this property to a value will send the psu[X].measure.tempcomp = value command.
TSP Syntax 
- psu[X].measure.tempcomp = value
- print(psu[X].measure.tempcomp)
Info
  • X, the module channel number.
Raises:

i 

i(reading_buffer: str | None = None) -> str

Run the psu[X].measure.i() function.

Description
  • This function makes one or more measurements. (i = current in amperes)
TSP Syntax 
- psu[X].measure.i()
Parameters:
  • reading_buffer (optional, default: None ) –

    Reading buffer where the readings are stored; can be a dynamically allocated user-defined buffer or a dedicated reading buffer.
Returns:
  • str –

    The result of the function call.
Raises:

overlappedi 

overlappedi(rbuffer: str) -> None

Run the psu[X].measure.overlappedi() function.

Description
  • This function starts an asynchronous (background) measurement. (i = current in amperes)
TSP Syntax 
- psu[X].measure.overlappedi()
Parameters:
  • rbuffer (str) –

    A reading buffer object where readings are stored.
Raises:

overlappediv 

overlappediv(ibuffer: str, vbuffer: str) -> None

Run the psu[X].measure.overlappediv() function.

Description
  • This function starts an asynchronous (background) measurement. (i = current in amperes, v = voltage in volts)
TSP Syntax 
- psu[X].measure.overlappediv()
Parameters:
  • ibuffer (str) –

    A reading buffer object where current readings are stored.

  • vbuffer (str) –

    A reading buffer object where voltage readings are stored.
Raises:

overlappedp 

overlappedp(rbuffer: str) -> None

Run the psu[X].measure.overlappedp() function.

Description
  • This function starts an asynchronous (background) measurement. (p = power in watts)
TSP Syntax 
- psu[X].measure.overlappedp()
Parameters:
  • rbuffer (str) –

    A reading buffer object where readings are stored.
Raises:

overlappedr 

overlappedr(rbuffer: str) -> None

Run the psu[X].measure.overlappedr() function.

Description
  • This function starts an asynchronous (background) measurement. (r = resistance in ohms)
TSP Syntax 
- psu[X].measure.overlappedr()
Parameters:
  • rbuffer (str) –

    A reading buffer object where readings are stored.
Raises:

overlappedv 

overlappedv(rbuffer: str) -> None

Run the psu[X].measure.overlappedv() function.

Description
  • This function starts an asynchronous (background) measurement. (v = voltage in volts)
TSP Syntax 
- psu[X].measure.overlappedv()
Parameters:
  • rbuffer (str) –

    A reading buffer object where readings are stored.
Raises:

p 

p(reading_buffer: str | None = None) -> str

Run the psu[X].measure.p() function.

Description
  • This function makes one or more measurements. (p = power in watts)
TSP Syntax 
- psu[X].measure.p()
Parameters:
  • reading_buffer (optional, default: None ) –

    Reading buffer where the readings are stored; can be a dynamically allocated user-defined buffer or a dedicated reading buffer.
Returns:
  • str –

    The result of the function call.
Raises:

r 

r(reading_buffer: str | None = None) -> str

Run the psu[X].measure.r() function.

Description
  • This function makes one or more measurements. (r = resistance in ohms)
TSP Syntax 
- psu[X].measure.r()
Parameters:
  • reading_buffer (optional, default: None ) –

    Reading buffer where the readings are stored; can be a dynamically allocated user-defined buffer or a dedicated reading buffer.
Returns:
  • str –

    The result of the function call.
Raises:

v 

v(reading_buffer: str | None = None) -> str

Run the psu[X].measure.v() function.

Description
  • This function makes one or more measurements. (v = voltage in volts)
TSP Syntax 
- psu[X].measure.v()
Parameters:
  • reading_buffer (optional, default: None ) –

    Reading buffer where the readings are stored; can be a dynamically allocated user-defined buffer or a dedicated reading buffer.
Returns:
  • str –

    The result of the function call.
Raises:

PsuItemMeasureRel

Bases: BaseTSPCmd

The psu[X].measure.rel command tree.

Properties and methods
  • .enablei: The psu[X].measure.rel.enablei attribute.
  • .enablep: The psu[X].measure.rel.enablep attribute.
  • .enabler: The psu[X].measure.rel.enabler attribute.
  • .enablev: The psu[X].measure.rel.enablev attribute.
  • .leveli: The psu[X].measure.rel.leveli attribute.
  • .levelp: The psu[X].measure.rel.levelp attribute.
  • .levelr: The psu[X].measure.rel.levelr attribute.
  • .levelv: The psu[X].measure.rel.levelv attribute.

enablei property writable 

enablei: str

Access the psu[X].measure.rel.enablei attribute.

Description
  • This attribute turns relative measurements on or off. (i = current in amperes)
Usage
  • Accessing this property will send the print(psu[X].measure.rel.enablei) query.
  • Setting this property to a value will send the psu[X].measure.rel.enablei = value command.
TSP Syntax 
- psu[X].measure.rel.enablei = value
- print(psu[X].measure.rel.enablei)
Raises:

enablep property writable 

enablep: str

Access the psu[X].measure.rel.enablep attribute.

Description
  • This attribute turns relative measurements on or off. (p = power in watts)
Usage
  • Accessing this property will send the print(psu[X].measure.rel.enablep) query.
  • Setting this property to a value will send the psu[X].measure.rel.enablep = value command.
TSP Syntax 
- psu[X].measure.rel.enablep = value
- print(psu[X].measure.rel.enablep)
Raises:

enabler property writable 

enabler: str

Access the psu[X].measure.rel.enabler attribute.

Description
  • This attribute turns relative measurements on or off. (r = resistance in ohms)
Usage
  • Accessing this property will send the print(psu[X].measure.rel.enabler) query.
  • Setting this property to a value will send the psu[X].measure.rel.enabler = value command.
TSP Syntax 
- psu[X].measure.rel.enabler = value
- print(psu[X].measure.rel.enabler)
Raises:

enablev property writable 

enablev: str

Access the psu[X].measure.rel.enablev attribute.

Description
  • This attribute turns relative measurements on or off. (v = voltage in volts)
Usage
  • Accessing this property will send the print(psu[X].measure.rel.enablev) query.
  • Setting this property to a value will send the psu[X].measure.rel.enablev = value command.
TSP Syntax 
- psu[X].measure.rel.enablev = value
- print(psu[X].measure.rel.enablev)
Raises:

leveli property writable 

leveli: str

Access the psu[X].measure.rel.leveli attribute.

Description
  • This attribute specifies the offset value for relative measurements. (i = current in amperes)
Usage
  • Accessing this property will send the print(psu[X].measure.rel.leveli) query.
  • Setting this property to a value will send the psu[X].measure.rel.leveli = value command.
TSP Syntax 
- psu[X].measure.rel.leveli = value
- print(psu[X].measure.rel.leveli)
Raises:

levelp property writable 

levelp: str

Access the psu[X].measure.rel.levelp attribute.

Description
  • This attribute specifies the offset value for relative measurements. (p = power in watts)
Usage
  • Accessing this property will send the print(psu[X].measure.rel.levelp) query.
  • Setting this property to a value will send the psu[X].measure.rel.levelp = value command.
TSP Syntax 
- psu[X].measure.rel.levelp = value
- print(psu[X].measure.rel.levelp)
Raises:

levelr property writable 

levelr: str

Access the psu[X].measure.rel.levelr attribute.

Description
  • This attribute specifies the offset value for relative measurements. (r = resistance in ohms)
Usage
  • Accessing this property will send the print(psu[X].measure.rel.levelr) query.
  • Setting this property to a value will send the psu[X].measure.rel.levelr = value command.
TSP Syntax 
- psu[X].measure.rel.levelr = value
- print(psu[X].measure.rel.levelr)
Raises:

levelv property writable 

levelv: str

Access the psu[X].measure.rel.levelv attribute.

Description
  • This attribute specifies the offset value for relative measurements. (v = voltage in volts)
Usage
  • Accessing this property will send the print(psu[X].measure.rel.levelv) query.
  • Setting this property to a value will send the psu[X].measure.rel.levelv = value command.
TSP Syntax 
- psu[X].measure.rel.levelv = value
- print(psu[X].measure.rel.levelv)
Raises:

PsuItemSource

Bases: BaseTSPCmd

The psu[X].source command tree.

Info
  • X, the module channel number.
Properties and methods
  • .constantcurrent: The psu[X].source.constantcurrent attribute.
  • .levelv: The psu[X].source.levelv attribute.
  • .limiti: The psu[X].source.limiti attribute.
  • .offmode: The psu[X].source.offmode attribute.
  • .output: The psu[X].source.output attribute.
  • .protect: The psu[X].source.protect command tree.
  • .rangev: The psu[X].source.rangev attribute.
  • .slewratev: The psu[X].source.slewratev attribute.

constantcurrent property 

constantcurrent: str

Access the psu[X].source.constantcurrent attribute.

Description
  • This attribute indicates when the source is within the current limit.
Usage
  • Accessing this property will send the print(psu[X].source.constantcurrent) query.
TSP Syntax 
- print(psu[X].source.constantcurrent)
Info
  • X, the module channel number.
Raises:

levelv property writable 

levelv: str

Access the psu[X].source.levelv attribute.

Description
  • This attribute configures the voltage source level.
Usage
  • Accessing this property will send the print(psu[X].source.levelv) query.
  • Setting this property to a value will send the psu[X].source.levelv = value command.
TSP Syntax 
- psu[X].source.levelv = value
- print(psu[X].source.levelv)
Info
  • X, the module channel number.
Raises:

limiti property writable 

limiti: str

Access the psu[X].source.limiti attribute.

Description
  • This attribute configures the source current limit.
Usage
  • Accessing this property will send the print(psu[X].source.limiti) query.
  • Setting this property to a value will send the psu[X].source.limiti = value command.
TSP Syntax 
- psu[X].source.limiti = value
- print(psu[X].source.limiti)
Info
  • X, the module channel number.
Raises:

offmode property writable 

offmode: str

Access the psu[X].source.offmode attribute.

Description
  • This attribute sets the source output-off mode.
Usage
  • Accessing this property will send the print(psu[X].source.offmode) query.
  • Setting this property to a value will send the psu[X].source.offmode = value command.
TSP Syntax 
- psu[X].source.offmode = value
- print(psu[X].source.offmode)
Raises:

output property writable 

output: str

Access the psu[X].source.output attribute.

Description
  • This attribute enables or disables the source output.
Usage
  • Accessing this property will send the print(psu[X].source.output) query.
  • Setting this property to a value will send the psu[X].source.output = value command.
TSP Syntax 
- psu[X].source.output = value
- print(psu[X].source.output)
Raises:

protect property 

protect: PsuItemSourceProtect

Return the psu[X].source.protect command tree.

Sub-properties and sub-methods
  • .enablei: The psu[X].source.protect.enablei attribute.
  • .enablev: The psu[X].source.protect.enablev attribute.
  • .leveli: The psu[X].source.protect.leveli attribute.
  • .levelv: The psu[X].source.protect.levelv attribute.
  • .trippedi: The psu[X].source.protect.trippedi attribute.
  • .trippedv: The psu[X].source.protect.trippedv attribute.

rangev property writable 

rangev: str

Access the psu[X].source.rangev attribute.

Description
  • This attribute contains the value of the source range for voltage.
Usage
  • Accessing this property will send the print(psu[X].source.rangev) query.
  • Setting this property to a value will send the psu[X].source.rangev = value command.
TSP Syntax 
- psu[X].source.rangev = value
- print(psu[X].source.rangev)
Info
  • X, the module channel number.
Raises:

slewratev property writable 

slewratev: str

Access the psu[X].source.slewratev attribute.

Description
  • This attribute configures the voltage source slew rate.
Usage
  • Accessing this property will send the print(psu[X].source.slewratev) query.
  • Setting this property to a value will send the psu[X].source.slewratev = value command.
TSP Syntax 
- psu[X].source.slewratev = value
- print(psu[X].source.slewratev)
Info
  • X, the module channel number.
Raises:

PsuItemSourceProtect

Bases: BaseTSPCmd

The psu[X].source.protect command tree.

Properties and methods
  • .enablei: The psu[X].source.protect.enablei attribute.
  • .enablev: The psu[X].source.protect.enablev attribute.
  • .leveli: The psu[X].source.protect.leveli attribute.
  • .levelv: The psu[X].source.protect.levelv attribute.
  • .trippedi: The psu[X].source.protect.trippedi attribute.
  • .trippedv: The psu[X].source.protect.trippedv attribute.

enablei property writable 

enablei: str

Access the psu[X].source.protect.enablei attribute.

Description
  • This attribute enables or disables the overcurrent protection function.
Usage
  • Accessing this property will send the print(psu[X].source.protect.enablei) query.
  • Setting this property to a value will send the psu[X].source.protect.enablei = value command.
TSP Syntax 
- psu[X].source.protect.enablei = value
- print(psu[X].source.protect.enablei)
Raises:

enablev property writable 

enablev: str

Access the psu[X].source.protect.enablev attribute.

Description
  • This attribute enables or disables the overvoltage protection function.
Usage
  • Accessing this property will send the print(psu[X].source.protect.enablev) query.
  • Setting this property to a value will send the psu[X].source.protect.enablev = value command.
TSP Syntax 
- psu[X].source.protect.enablev = value
- print(psu[X].source.protect.enablev)
Raises:

leveli property writable 

leveli: str

Access the psu[X].source.protect.leveli attribute.

Description
  • This attribute configures the overcurrent protection level.
Usage
  • Accessing this property will send the print(psu[X].source.protect.leveli) query.
  • Setting this property to a value will send the psu[X].source.protect.leveli = value command.
TSP Syntax 
- psu[X].source.protect.leveli = value
- print(psu[X].source.protect.leveli)
Info
  • X, the module channel number.
Raises:

levelv property writable 

levelv: str

Access the psu[X].source.protect.levelv attribute.

Description
  • This attribute configures the overvoltage protection level.
Usage
  • Accessing this property will send the print(psu[X].source.protect.levelv) query.
  • Setting this property to a value will send the psu[X].source.protect.levelv = value command.
TSP Syntax 
- psu[X].source.protect.levelv = value
- print(psu[X].source.protect.levelv)
Info
  • X, the module channel number.
Raises:

trippedi property 

trippedi: str

Access the psu[X].source.protect.trippedi attribute.

Description
  • This attribute indicates if the overcurrent protection circuit was tripped.
Usage
  • Accessing this property will send the print(psu[X].source.protect.trippedi) query.
TSP Syntax 
- print(psu[X].source.protect.trippedi)
Info
  • X, the module channel number.
Raises:

trippedv property 

trippedv: str

Access the psu[X].source.protect.trippedv attribute.

Description
  • This attribute indicates if the overvoltage protection circuit was tripped.
Usage
  • Accessing this property will send the print(psu[X].source.protect.trippedv) query.
TSP Syntax 
- print(psu[X].source.protect.trippedv)
Info
  • X, the module channel number.
Raises:

PsuItemTrigger

Bases: BaseTSPCmd

The psu[X].trigger command tree.

Properties and methods
  • .measure: The psu[X].trigger.measure command tree.
  • .source: The psu[X].trigger.source command tree.

measure property 

measure: PsuItemTriggerMeasure

Return the psu[X].trigger.measure command tree.

Sub-properties and sub-methods
  • .i(): The psu[X].trigger.measure.i() function.
  • .iv(): The psu[X].trigger.measure.iv() function.
  • .p(): The psu[X].trigger.measure.p() function.
  • .r(): The psu[X].trigger.measure.r() function.
  • .v(): The psu[X].trigger.measure.v() function.

source property 

source: PsuItemTriggerSource

Return the psu[X].trigger.source command tree.

Sub-properties and sub-methods
  • .linearv(): The psu[X].trigger.source.linearv() function.
  • .listv(): The psu[X].trigger.source.listv() function.
  • .logv(): The psu[X].trigger.source.logv() function.

PsuItemTriggerMeasure

Bases: BaseTSPCmd

The psu[X].trigger.measure command tree.

Properties and methods
  • .i(): The psu[X].trigger.measure.i() function.
  • .iv(): The psu[X].trigger.measure.iv() function.
  • .p(): The psu[X].trigger.measure.p() function.
  • .r(): The psu[X].trigger.measure.r() function.
  • .v(): The psu[X].trigger.measure.v() function.

i 

i(reading_buffer: str) -> None

Run the psu[X].trigger.measure.i() function.

Description
  • This function configures the reading buffer and measure type for the trigger model. (i = current in amperes)
TSP Syntax 
- psu[X].trigger.measure.i()
Parameters:
  • reading_buffer (str) –

    Buffer to store the measurement result.
Raises:

iv 

iv(ibuffer: str, vbuffer: str) -> None

Run the psu[X].trigger.measure.iv() function.

Description
  • This function configures the reading buffer and measure type for the trigger model. (i = current in amperes, v = voltage in volts)
TSP Syntax 
- psu[X].trigger.measure.iv()
Parameters:
  • ibuffer (str) –

    Buffer to store current readings.

  • vbuffer (str) –

    Buffer to store voltage readings.
Raises:

p 

p(reading_buffer: str) -> None

Run the psu[X].trigger.measure.p() function.

Description
  • This function configures the reading buffer and measure type for the trigger model. (p = power in watts)
TSP Syntax 
- psu[X].trigger.measure.p()
Parameters:
  • reading_buffer (str) –

    Buffer to store the measurement result.
Raises:

r 

r(reading_buffer: str) -> None

Run the psu[X].trigger.measure.r() function.

Description
  • This function configures the reading buffer and measure type for the trigger model. (r = resistance in ohms)
TSP Syntax 
- psu[X].trigger.measure.r()
Parameters:
  • reading_buffer (str) –

    Buffer to store the measurement result.
Raises:

v 

v(reading_buffer: str) -> None

Run the psu[X].trigger.measure.v() function.

Description
  • This function configures the reading buffer and measure type for the trigger model. (v = voltage in volts)
TSP Syntax 
- psu[X].trigger.measure.v()
Parameters:
  • reading_buffer (str) –

    Buffer to store the measurement result.
Raises:

PsuItemTriggerSource

Bases: BaseTSPCmd

The psu[X].trigger.source command tree.

Properties and methods
  • .linearv(): The psu[X].trigger.source.linearv() function.
  • .listv(): The psu[X].trigger.source.listv() function.
  • .logv(): The psu[X].trigger.source.logv() function.

linearv 

linearv(start: str, end: str, points: str) -> None

Run the psu[X].trigger.source.linearv() function.

Description
  • This function configures the linear sweep for the trigger model. (v = voltage in volts)
TSP Syntax 
- psu[X].trigger.source.linearv()
Parameters:
  • start (str) –

    Start source level.

  • end (str) –

    End source level.

  • points (str) –

    Number of points used to calculate the step size.
Raises:

listv 

listv(source_levels: str) -> None

Run the psu[X].trigger.source.listv() function.

Description
  • This function configures the list sweep for the trigger model. (v = voltage in volts)
TSP Syntax 
- psu[X].trigger.source.listv()
Parameters:
  • source_levels (str) –

    List of source levels. Each time a source block is reached, the index increases by 1. When it reaches the end, it cycles back to the beginning.

For example, ({1, 2, 3}).

Raises:

logv 

logv(start: str, end: str, points: str) -> None

Run the psu[X].trigger.source.logv() function.

Description
  • This function configures a logarithmic sweep for the trigger model. (v = voltage in volts)
TSP Syntax 
- psu[X].trigger.source.logv()
Parameters:
  • start (str) –

    Start source level.

  • end (str) –

    End source level.

  • points (str) –

    Number of points used to calculate the step size.
Raises: