From 0f2a3b9b68dae48df99b8fa5b54e3e6123c7ccca Mon Sep 17 00:00:00 2001
From: Daniel Friesel <daniel.friesel@uos.de>
Date: Tue, 23 Mar 2021 16:14:38 +0100
Subject: doku

---
 lib/loader/keysight.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'lib/loader')

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
-- 
cgit v1.2.3