From 5086505de32569f238cc5280a94806782334d0d7 Mon Sep 17 00:00:00 2001
From: test <alexldewar@gmail.com>
Date: Fri, 26 Mar 2021 13:12:51 -0300
Subject: [PATCH] Document get_serial_ports()

---
 docs/api.rst                                     | 4 ++++
 software/chipwhisperer/capture/scopes/OpenADC.py | 6 ++++++
 software/chipwhisperer/capture/scopes/cwnano.py  | 5 +++++
 3 files changed, 15 insertions(+)

diff --git a/docs/api.rst b/docs/api.rst
index ea10ff095d..5b1bd8c08d 100644
--- 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
index e5aeb64d8a..527ea54f61 100644
--- 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
index b3759a6938..63c2c55e51 100644
--- 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