1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
#
# This file is part of the PyMeasure package.
#
# Copyright (c) 2013-2024 PyMeasure Developers
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
import logging
from time import sleep
import re
import numpy as np
from pymeasure.instruments import Instrument, SCPIUnknownMixin
from pymeasure.instruments.validators import (
truncated_discrete_set, strict_discrete_set,
truncated_range
)
log = logging.getLogger(__name__)
log.addHandler(logging.NullHandler())
class Yokogawa7651(SCPIUnknownMixin, Instrument):
""" Represents the Yokogawa 7651 Programmable DC Source
and provides a high-level for interacting with the instrument.
.. code-block:: python
yoko = Yokogawa7651("GPIB::1")
yoko.apply_current() # Sets up to source current
yoko.source_current_range = 10e-3 # Sets the current range to 10 mA
yoko.compliance_voltage = 10 # Sets the compliance voltage to 10 V
yoko.source_current = 0 # Sets the source current to 0 mA
yoko.enable_source() # Enables the current output
yoko.ramp_to_current(5e-3) # Ramps the current to 5 mA
yoko.shutdown() # Ramps the current to 0 mA and disables output
"""
@staticmethod
def _find(v, key):
""" Returns a value by parsing a current panel setting output
string array, which is returned with a call to "OS;E". This
is used for Instrument.control methods, and should not be
called directly by the user.
"""
status = ''.join(v.split("\r\n\n")[1:-1])
keys = re.findall(r'[^\dE+.-]+', status)
values = re.findall(r'[\dE+.-]+', status)
if key not in keys:
raise ValueError("Invalid key used to search for status of Yokogawa 7561")
else:
return values[keys.index(key)]
source_voltage = Instrument.control(
"OD;E", "S%g;E",
"""Control the source voltage in Volts, if that mode is active. (float)"""
)
source_current = Instrument.control(
"OD;E", "S%g;E",
"""Control the source current in Amps, if that mode is active. (float)"""
)
source_voltage_range = Instrument.control(
"OS;E", "R%d;E",
"""Control the source voltage range in Volts, which can take values:
10 mV, 100 mV, 1 V, 10 V, and 30 V.
Voltages are truncated to an appropriate value if needed. """,
validator=truncated_discrete_set,
values={10e-3: 2, 100e-3: 3, 1: 4, 10: 5, 30: 6},
map_values=True,
get_process=lambda v: int(Yokogawa7651._find(v, 'R'))
)
source_current_range = Instrument.control(
"OS;E", "R%d;E",
"""Control the current voltage range in Amps, which can take values:
1 mA, 10 mA, and 100 mA.
Currents are truncated to an appropriate value if needed. """,
validator=truncated_discrete_set,
values={1e-3: 4, 10e-3: 5, 100e-3: 6},
map_values=True,
get_process=lambda v: int(Yokogawa7651._find(v, 'R'))
)
source_mode = Instrument.control(
"OS;E", "F%d;E",
"""Control the source mode, which can take the values 'current' or 'voltage'.
The convenience methods :meth:`~.Yokogawa7651.apply_current` and
:meth:`~.Yokogawa7651.apply_voltage` can also be used. """,
validator=strict_discrete_set,
values={'current': 5, 'voltage': 1},
map_values=True,
get_process=lambda v: int(Yokogawa7651._find(v, 'F'))
)
compliance_voltage = Instrument.control(
"OS;E", "LV%g;E",
"""Control the compliance voltage in Volts, which can take values between 1 and 30 V.""",
validator=truncated_range,
values=[1, 30],
get_process=lambda v: int(Yokogawa7651._find(v, 'LV'))
)
compliance_current = Instrument.control(
"OS;E", "LA%g;E",
"""Control the compliance current in Amps,which can take values from 5 to 120 mA.""",
validator=truncated_range,
values=[5e-3, 120e-3],
get_process=lambda v: float(Yokogawa7651._find(v, 'LA')) * 1e-3, # converts A to mA
set_process=lambda v: v * 1e3, # converts mA to A
)
def __init__(self, adapter, name="Yokogawa 7651 Programmable DC Source", **kwargs):
super().__init__(
adapter, name, **kwargs
)
self.write("H0;E") # Set no header in output data
@property
def id(self):
""" Get the identification of the instrument """
return self.ask("OS;E").split('\r\n\n')[0]
@property
def source_enabled(self):
""" Get a boolean value that is True if the source is enabled,
determined by checking if the 5th bit of the OC flag is a binary 1.
"""
oc = int(self.ask("OC;E")[5:])
return oc & 0b10000
def enable_source(self):
""" Enables the source of current or voltage depending on the
configuration of the instrument. """
self.write("O1;E")
def disable_source(self):
""" Disables the source of current or voltage depending on the
configuration of the instrument. """
self.write("O0;E")
def apply_current(self, max_current=1e-3, compliance_voltage=1):
""" Configures the instrument to apply a source current, which can
take optional parameters that defer to the :attr:`~.Yokogawa7651.source_current_range`
and :attr:`~.Yokogawa7651.compliance_voltage` properties. """
self.source_mode = 'current'
self.source_current_range = max_current
self.compliance_voltage = compliance_voltage
def apply_voltage(self, max_voltage=1, compliance_current=10e-3):
""" Configures the instrument to apply a source voltage, which can
take optional parameters that defer to the :attr:`~.Yokogawa7651.source_voltage_range`
and :attr:`~.Yokogawa7651.compliance_current` properties. """
self.source_mode = 'voltage'
self.source_voltage_range = max_voltage
self.compliance_current = compliance_current
def ramp_to_current(self, current, steps=25, duration=0.5):
""" Ramps the current to a value in Amps by traversing a linear spacing
of current steps over a duration, defined in seconds.
:param steps: A number of linear steps to traverse
:param duration: A time in seconds over which to ramp
"""
start_current = self.source_current
stop_current = current
pause = duration / steps
if (start_current != stop_current):
currents = np.linspace(start_current, stop_current, steps)
for current in currents:
self.source_current = current
sleep(pause)
def ramp_to_voltage(self, voltage, steps=25, duration=0.5):
""" Ramps the voltage to a value in Volts by traversing a linear spacing
of voltage steps over a duration, defined in seconds.
:param steps: A number of linear steps to traverse
:param duration: A time in seconds over which to ramp
"""
start_voltage = self.source_voltage
stop_voltage = voltage
pause = duration / steps
if (start_voltage != stop_voltage):
voltages = np.linspace(start_voltage, stop_voltage, steps)
for voltage in voltages:
self.source_voltage = voltage
sleep(pause)
def shutdown(self):
""" Shuts down the instrument, and ramps the current or voltage to zero
before disabling the source. """
# Since voltage and current are set the same way, this
# ramps either the current or voltage to zero
self.ramp_to_current(0.0, steps=25)
self.source_current = 0.0
self.disable_source()
super().shutdown()
|
