aboutsummaryrefslogtreecommitdiff
path: root/pyecsca/sca/scope/picoscope.py
blob: 8497c6487543776cd438ae5b73586ec029366a57 (plain)
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
import ctypes
from enum import IntEnum
from math import log2, floor
from typing import Mapping, Optional, MutableMapping, Union

import numpy as np
from picosdk.functions import assert_pico_ok
from picosdk.library import Library
from picosdk.ps4000 import ps4000
from picosdk.ps6000 import ps6000
from public import public

from .base import Scope


class TriggerType(IntEnum):  # pragma: no cover
    ABOVE = 1
    BELOW = 2
    RISING = 3
    FALLING = 4


def adc2volt(adc: Union[np.ndarray, ctypes.c_int16],
             volt_range: float, adc_minmax: int) -> Union[np.ndarray, float]:  # pragma: no cover
    if isinstance(adc, ctypes.c_int16):
        adc = adc.value
    return (adc / adc_minmax) * volt_range


def volt2adc(volt: Union[np.ndarray, float],
             volt_range: float, adc_minmax: int) -> Union[
    np.ndarray, ctypes.c_int16]:  # pragma: no cover
    if isinstance(volt, float):
        return ctypes.c_int16(int((volt / volt_range) * adc_minmax))
    return (volt / volt_range) * adc_minmax


class PicoScope(Scope):  # pragma: no cover
    """A PicoScope based scope."""
    MODULE: Library
    PREFIX: str
    CHANNELS: Mapping
    RANGES: Mapping
    MAX_ADC_VALUE: int
    MIN_ADC_VALUE: int
    COUPLING: Mapping
    TIME_UNITS: Mapping

    def __init__(self):
        self.handle: ctypes.c_int16 = ctypes.c_int16()
        self.frequency: Optional[float] = None
        self.samples: Optional[int] = None
        self.timebase: Optional[int] = None
        self.buffers: MutableMapping = {}
        self.ranges: MutableMapping = {}

    def open(self):
        assert_pico_ok(self.__dispatch_call("OpenUnit", ctypes.byref(self.handle)))

    def get_variant(self):
        info = (ctypes.c_int8 * 6)()
        size = ctypes.c_int16()
        assert_pico_ok(self.__dispatch_call("GetUnitInfo", self.handle, ctypes.byref(info), 6,
                                            ctypes.byref(size), 3))
        return "".join(chr(i) for i in info[:size])

    # channel setup (ranges, coupling, which channel is scope vs trigger)
    def set_channel(self, channel: str, enabled: bool, coupling: str, range: float):
        assert_pico_ok(
                self.__dispatch_call("SetChannel", self.handle, self.CHANNELS[channel], enabled,
                                     self.COUPLING[coupling], self.RANGES[range]))
        self.ranges[channel] = range

    def _set_freq(self, frequency: int, samples: int, period_bound: float, timebase_bound: int,
                  low_freq: int, high_freq: int, high_subtract: int):
        period = 1 / frequency
        if low_freq == 0 or period > period_bound:
            tb = floor(high_freq / frequency + high_subtract)
            actual_frequency = high_freq / (tb - high_subtract)
        else:
            tb = floor(log2(low_freq) - log2(frequency))
            if tb > timebase_bound:
                tb = timebase_bound
            actual_frequency = low_freq / 2 ** tb
        max_samples = ctypes.c_int32()
        assert_pico_ok(self.__dispatch_call("GetTimebase", self.handle, tb, samples, None, 0,
                                            ctypes.byref(max_samples), 0))
        if max_samples.value < samples:
            samples = max_samples.value
        self.frequency = actual_frequency
        self.samples = samples
        self.timebase = tb
        return actual_frequency, samples

    # frequency setup
    def set_frequency(self, frequency: int, samples: int):
        raise NotImplementedError

    # triggering setup
    def set_trigger(self, type: TriggerType, enabled: bool, value: float, channel: str,
                    range: float, delay: int, timeout: int):
        assert_pico_ok(
                self.__dispatch_call("SetSimpleTrigger", self.handle, enabled,
                                     self.CHANNELS[channel],
                                     volt2adc(value, range, self.MAX_ADC_VALUE),
                                     type.value, delay, timeout))

    # buffer setup
    def set_buffer(self, channel: str):
        if self.samples is None:
            raise ValueError
        buffer = (ctypes.c_int16 * self.samples)()
        self.buffers[channel] = buffer
        assert_pico_ok(self.__dispatch_call("SetDataBuffer", self.handle, self.CHANNELS[channel],
                                            ctypes.byref(buffer), self.samples))

    # collection
    def collect(self):
        if self.samples is None or self.timebase is None:
            raise ValueError
        assert_pico_ok(
                self.__dispatch_call("RunBlock", self.handle, 0, self.samples, self.timebase, 0,
                                     None,
                                     0, None, None))
        ready = ctypes.c_int16(0)
        check = ctypes.c_int16(0)
        while ready.value == check.value:
            assert_pico_ok(self.__dispatch_call("IsReady", self.handle, ctypes.byref(ready)))

    # get the data
    def retrieve(self, channel: str) -> np.ndarray:
        if self.samples is None:
            raise ValueError
        actual_samples = ctypes.c_int32(self.samples)
        overflow = ctypes.c_int16()
        assert_pico_ok(
                self.__dispatch_call("GetValues", self.handle, 0, ctypes.byref(actual_samples), 1,
                                     0, 0,
                                     ctypes.byref(overflow)))
        arr = np.array(self.buffers[channel], dtype=np.int16)
        return adc2volt(arr, self.ranges[channel], self.MAX_ADC_VALUE)

    # stop
    def stop(self):
        assert_pico_ok(self.__dispatch_call("Stop"))

    def close(self):
        assert_pico_ok(self.__dispatch_call("CloseUnit", self.handle))

    def __dispatch_call(self, name, *args, **kwargs):
        method = getattr(self.MODULE, self.PREFIX + name)
        if method is None:
            raise ValueError
        return method(*args, **kwargs)


@public
class PS4000Scope(PicoScope):  # pragma: no cover
    MODULE = ps4000
    PREFIX = "ps4000"
    CHANNELS = {
        "A": ps4000.PS4000_CHANNEL["PS4000_CHANNEL_A"],
        "B": ps4000.PS4000_CHANNEL["PS4000_CHANNEL_B"],
        "C": ps4000.PS4000_CHANNEL["PS4000_CHANNEL_C"],
        "D": ps4000.PS4000_CHANNEL["PS4000_CHANNEL_D"]
    }

    RANGES = {
        0.01: ps4000.PS4000_RANGE["PS4000_10MV"],
        0.02: ps4000.PS4000_RANGE["PS4000_20MV"],
        0.05: ps4000.PS4000_RANGE["PS4000_50MV"],
        0.10: ps4000.PS4000_RANGE["PS4000_100MV"],
        0.20: ps4000.PS4000_RANGE["PS4000_200MV"],
        0.50: ps4000.PS4000_RANGE["PS4000_500MV"],
        1.00: ps4000.PS4000_RANGE["PS4000_1V"],
        2.00: ps4000.PS4000_RANGE["PS4000_2V"],
        5.00: ps4000.PS4000_RANGE["PS4000_5V"],
        10.0: ps4000.PS4000_RANGE["PS4000_10V"],
        20.0: ps4000.PS4000_RANGE["PS4000_20V"],
        50.0: ps4000.PS4000_RANGE["PS4000_50V"],
        100.0: ps4000.PS4000_RANGE["PS4000_100V"]
    }

    MAX_ADC_VALUE = 32764
    MIN_ADC_VALUE = -32764

    COUPLING = {
        "AC": ps4000.PICO_COUPLING["AC"],
        "DC": ps4000.PICO_COUPLING["DC"]
    }

    def set_frequency(self, frequency: int, samples: int):
        variant = self.get_variant()
        if variant in ("4223", "4224", "4423", "4424"):
            return self._set_freq(frequency, samples, 50e-9, 2, 80_000_000, 20_000_000, 1)
        elif variant in ("4226", "4227"):
            return self._set_freq(frequency, samples, 32e-9, 3, 250_000_000, 31_250_000, 2)
        elif variant == "4262":
            return self._set_freq(frequency, samples, 0, 0, 0, 10_000_000, -1)


@public
class PS6000Scope(PicoScope):  # pragma: no cover
    MODULE = ps6000
    PREFIX = "ps6000"
    CHANNELS = {
        "A": ps6000.PS6000_CHANNEL["PS6000_CHANNEL_A"],
        "B": ps6000.PS6000_CHANNEL["PS6000_CHANNEL_B"],
        "C": ps6000.PS6000_CHANNEL["PS6000_CHANNEL_C"],
        "D": ps6000.PS6000_CHANNEL["PS6000_CHANNEL_D"]
    }

    RANGES = {
        0.01: ps6000.PS6000_RANGE["PS6000A_10MV"],
        0.02: ps6000.PS6000_RANGE["PS6000_20MV"],
        0.05: ps6000.PS6000_RANGE["PS6000_50MV"],
        0.10: ps6000.PS6000_RANGE["PS6000_100MV"],
        0.20: ps6000.PS6000_RANGE["PS6000_200MV"],
        0.50: ps6000.PS6000_RANGE["PS6000_500MV"],
        1.00: ps6000.PS6000_RANGE["PS6000_1V"],
        2.00: ps6000.PS6000_RANGE["PS6000_2V"],
        5.00: ps6000.PS6000_RANGE["PS6000_5V"],
        10.0: ps6000.PS6000_RANGE["PS6000_10V"],
        20.0: ps6000.PS6000_RANGE["PS6000_20V"],
        50.0: ps6000.PS6000_RANGE["PS6000_50V"]
    }

    MAX_ADC_VALUE = 32512
    MIN_ADC_VALUE = -32512

    COUPLING = {
        "AC": ps6000.PS6000_COUPLING["PS6000_AC"],
        "DC": ps6000.PS6000_COUPLING["PS6000_DC_1M"]
    }

    def open(self):
        assert_pico_ok(ps6000.ps6000OpenUnit(ctypes.byref(self.handle), None))

    def set_channel(self, channel: str, enabled: bool, coupling: str, range: float):
        assert_pico_ok(ps6000.ps6000SetChannel(self.handle, self.CHANNELS[channel], enabled,
                                               self.COUPLING[coupling], self.RANGES[range], 0,
                                               ps6000.PS6000_BANDWIDTH_LIMITER["PS6000_BW_FULL"]))

    def set_buffer(self, channel: str):
        if self.samples is None:
            raise ValueError
        buffer = (ctypes.c_int16 * self.samples)()
        self.buffers[channel] = buffer
        assert_pico_ok(
                ps6000.ps6000SetDataBuffer(self.handle, self.CHANNELS[channel],
                                           ctypes.byref(buffer),
                                           self.samples, 0))

    def set_frequency(self, frequency: int, samples: int):
        return self._set_freq(frequency, samples, 3.2e-9, 4, 5_000_000_000, 156_250_000, 4)