diff options
| -rw-r--r-- | lib/loader/keysight.py | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/lib/loader/keysight.py b/lib/loader/keysight.py index 77330ad..98d09b4 100644 --- a/lib/loader/keysight.py +++ b/lib/loader/keysight.py @@ -50,6 +50,8 @@ class DLogChannel: class DLog(ExternalTimerSync): + """Loader for DLog files generated by Keysight power analyzers.""" + def __init__( self, voltage: float, @@ -58,6 +60,20 @@ class DLog(ExternalTimerSync): skip_duration=None, limit_duration=None, ): + """ + Create a new DLog object + + :param voltage: Voltage in V + :type voltage: float + :param state_duration: Expected state duration in ms. Used to detect and ignore UART transmissions in captured energy data. + :type state_duration: int + :param with_traces: Provide traces and timestamps, default false + :type with_traces: bool + :param skip_duration: Ignore the first `skip_duration` seconds, default None (ignore nothing) + :type skip_duration: float + :param limit_duration: Ignore everything after `limit_duration` seconds, default none (ignore nothing) + :type limit_duration: float + """ self.voltage = voltage self.state_duration = state_duration self.with_traces = with_traces |