aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--qolab/hardware/lockin/__init__.py14
1 files changed, 10 insertions, 4 deletions
diff --git a/qolab/hardware/lockin/__init__.py b/qolab/hardware/lockin/__init__.py
index 4f27414..5190d69 100644
--- a/qolab/hardware/lockin/__init__.py
+++ b/qolab/hardware/lockin/__init__.py
@@ -3,6 +3,9 @@ from qolab.hardware.basic import BasicInstrument
class Lockin(BasicInstrument):
+ """Basic lockin class with.
+ Intended to be expanded in hardware specific classes.
+ """
def __init__(self, *args, **kwds):
BasicInstrument.__init__(self, *args, **kwds)
self.config["Device type"] = "Lockin"
@@ -29,10 +32,13 @@ class Lockin(BasicInstrument):
class LockinSCPI(SCPIinstr, Lockin):
- """
- Do not instantiate directly, use
- rm = pyvisa.ResourceManager()
- LockinSCPI(rm.open_resource('TCPIP::192.168.0.2::INSTR'))
+ """Basic lockin class with SCPI interface.
+ Intended to be expanded in hardware specific classes.
+
+ Example
+ -------
+ >>> rm = pyvisa.ResourceManager()
+ >>> LockinSCPI(rm.open_resource('TCPIP::192.168.0.2::INSTR'))
"""
pass