aboutsummaryrefslogtreecommitdiff
path: root/qolab/hardware/scpi.py
diff options
context:
space:
mode:
Diffstat (limited to 'qolab/hardware/scpi.py')
-rw-r--r--qolab/hardware/scpi.py17
1 files changed, 12 insertions, 5 deletions
diff --git a/qolab/hardware/scpi.py b/qolab/hardware/scpi.py
index 4ba9d49..99760f3 100644
--- a/qolab/hardware/scpi.py
+++ b/qolab/hardware/scpi.py
@@ -53,6 +53,7 @@ def response2numStr(strIn, firstSeparator=None, unit=None):
class SCPI_PROPERTY(property):
"""Overrides 'property' class and makes it suitable for SCPI set and query notation.
+
Adds ability to log into TSDB.
Works within SCPIinstr class since it assumes that owner has query() and write().
@@ -69,9 +70,11 @@ class SCPI_PROPERTY(property):
doc : str or None (default)
short description of property, for example 'Internal lockin frequency'
no_getter: True of False (default)
- does property has a getter, some properties has no getter, e.g. output voldage of a DAC
+ does property has a getter, some properties has no getter,
+ e.g. output voltage of a DAC
no_setter : True of False (default)
- does property has a setter, some properties has no setter, e.g. measurement of external voltages for an ADC
+ does property has a setter, some properties has no setter,
+ e.g. measurement of external voltages for an ADC
tsdb_logging : True (default) or False
do we log get/set commands result/argument to TSDB
@@ -173,9 +176,13 @@ class SCPI_PROPERTY(property):
class SCPIinstr:
"""Basic class which support SCPI commands.
- Do not instantiate directly, use
- rm = pyvisa.ResourceManager()
- SCPIinstr(rm.open_resource('TCPIP::192.168.0.2::INSTR'))
+
+ Intended to be a parent for more hardware aware classes.
+
+ Example
+ -------
+ >>> rm = pyvisa.ResourceManager()
+ >>> SCPIinstr(rm.open_resource('TCPIP::192.168.0.2::INSTR'))
"""
def __init__(self, resource):