Document get_serial_ports()

newaetech · Mar 26, 2021 · 5086505 · 5086505
1 parent ac41e8b
commit 5086505
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -298,6 +298,8 @@ OpenADC Scope
 
     .. automethod:: chipwhisperer.capture.scopes.OpenADC.reload_fpga
 
+    .. automethod:: chipwhisperer.capture.scopes.OpenADC.get_serial_ports
+
     .. method:: dis()
 
         Disconnects the current scope object.
@@ -384,6 +386,8 @@ ChipWhisperer Nano Scope
 
     .. automethod:: chipwhisperer.capture.scopes.cwnano.CWNano.get_last_trace
 
+    .. automethod:: chipwhisperer.capture.scopes.cwnano.CWNano.get_serial_ports
+
     .. method:: dis()
 
         Disconnects the current scope object.

diff --git a/software/chipwhisperer/capture/scopes/OpenADC.py b/software/chipwhisperer/capture/scopes/OpenADC.py
@@ -127,6 +127,11 @@ def _getNAEUSB(self):
         return self.scopetype.dev._cwusb
 
     def get_serial_ports(self):
+        """ Get the CDC serial ports associated with this scope
+
+        Returns:
+            A list of a dict with elements {'port', 'interface'}
+        """
         return self._getNAEUSB().get_serial_ports()
 
     def default_setup(self):
@@ -140,6 +145,7 @@ def default_setup(self):
          *  4*7.37MHz ADC clock
          *  tio1 = serial rx
          *  tio2 = serial tx
+         *  CDC settings change off
 
         .. versionadded:: 5.1
             Added default setup for OpenADC

diff --git a/software/chipwhisperer/capture/scopes/cwnano.py b/software/chipwhisperer/capture/scopes/cwnano.py
@@ -620,6 +620,11 @@ def _getCWType(self):
         return 'cwnano'
 
     def get_serial_ports(self):
+        """ Get the CDC serial ports associated with this scope
+
+        Returns:
+            A list of a dict with elements {'port', 'interface'}
+        """
         return self._getNAEUSB().get_serial_ports()
 
     @property