diff options
| author | J08nY | 2021-04-11 14:16:57 +0200 |
|---|---|---|
| committer | J08nY | 2021-04-11 14:16:57 +0200 |
| commit | 942c0fb9d6fcbff7c91c553211cc81c7e0939e4e (patch) | |
| tree | 1df80da6030019ef2a7490d2b2050a7d4b9a83ec /pyecsca/sca/scope/base.py | |
| parent | a2e01e037fcde3e63571633e94156e324a4f2299 (diff) | |
| download | pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.tar.gz pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.tar.zst pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.zip | |
Diffstat (limited to 'pyecsca/sca/scope/base.py')
| -rw-r--r-- | pyecsca/sca/scope/base.py | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/pyecsca/sca/scope/base.py b/pyecsca/sca/scope/base.py index 595fe32..ced3009 100644 --- a/pyecsca/sca/scope/base.py +++ b/pyecsca/sca/scope/base.py @@ -1,6 +1,4 @@ -""" -This module provides an abstract base class for oscilloscopes. -""" +"""This module provides an abstract base class for oscilloscopes.""" from enum import Enum, auto from typing import Tuple, Sequence, Optional @@ -34,9 +32,11 @@ class Scope(object): self, frequency: int, pretrig: int, posttrig: int ) -> Tuple[int, int]: """ - Setup the frequency and sample count for the measurement. The scope might not support - the requested values and will adjust them to get the next best frequency and the largest - supported number of samples (or the number of samples requested). + Setup the frequency and sample count for the measurement. + + The scope might not support the requested values and will adjust them to get + the next best frequency and the largest supported number of samples + (or the number of samples requested). :param frequency: The requested frequency in Hz. :param pretrig: The requested number of samples to measure before the trigger. @@ -70,6 +70,7 @@ class Scope(object): ) -> None: """ Setup a trigger on a particular `channel`, the channel has to be set up and enabled. + The trigger will fire based on the `threshold` and `direction`, if enabled, the trigger will capture after `delay` ticks pass. If trigger conditions do not hold it will fire automatically after `timeout` milliseconds. |
