chore: move serial_port getter to nordic_boards

Signed-off-by: Maximilian Deubel <maximilian.deubel@nordicsemi.no>

Author: maxd-nordic

src/nrfcloud_utils/claim_and_provision_device.py

@@ -7,7 +7,6 @@
 import sys
 import time
 import json
-import serial
 import argparse
 import platform
 from nrfcloud_utils import (
@@ -19,10 +18,9 @@
     create_device_credentials
 )
 from nrfcloud_utils.cli_helpers import error_style, local_style, send_style, hivis_style, init_colorama, cli_disable_styles, is_linux, is_windows, is_macos
-from serial.tools import list_ports
 from cryptography import x509
 from cryptography.hazmat.primitives import serialization
-from nrfcloud_utils.nordic_boards import ask_for_port
+from nrfcloud_utils.nordic_boards import ask_for_port, get_serial_port
 
 full_encoding = 'mbcs' if is_windows else 'ascii'
 serial_timeout = 1
@@ -100,8 +98,7 @@ def parse_args(in_args):
     parser.add_argument("--prov-hex", type=str, help="Filepath to nRF Provisioning sample hex file",
                         default="")
     parser.add_argument("--api-key", type=str,
-                        help="API key",
-                        default=None)
+                        help="API key", required=True)
     parser.add_argument("--stage", type=str, help="For internal (Nordic) use only", default="")
     parser.add_argument("--attest", type=str,
                         help="Attestation token base64 string (AT%%ATTESTTOKEN result)",
@@ -326,13 +323,8 @@ def main(in_args):
     print(local_style('Selected serial port: {}'.format(port)))
 
     # try to open the serial port
-    try:
-        ser = serial.Serial(port, args.baud, xonxoff= args.xonxoff, rtscts=(not args.rtscts_off),
-                            dsrdtr=args.dsrdtr, timeout=serial_timeout)
-        ser.reset_input_buffer()
-        ser.reset_output_buffer()
-    except serial.serialutil.SerialException:
-        error_exit(ser, 'Port could not be opened; not a device, or open already')
+    ser = get_serial_port(port, args.baud, xonxoff= args.xonxoff, rtscts=(not args.rtscts_off),
+                          dsrdtr=args.dsrdtr)
 
     # disable modem, just so the provisioning client doesn't try to do anything...
     print(local_style('\nDisabling modem...'))

src/nrfcloud_utils/device_credentials_installer.py

@@ -9,15 +9,13 @@
 import os
 import sys
 import csv
-import serial
 import getpass
 import semver
 from nrfcloud_utils import create_device_credentials, ca_certs, rtt_interface
 from nrfcloud_utils.cli_helpers import error_style, local_style, send_style, hivis_style, init_colorama, cli_disable_styles, write_file, save_devinfo_csv, save_onboarding_csv, is_linux, is_windows, is_macos, full_encoding
 from nrfcloud_utils.command_interface import ATCommandInterface, ATKeygenException, TLSCredShellInterface
-from nrfcloud_utils.nordic_boards import ask_for_port
+from nrfcloud_utils.nordic_boards import ask_for_port, get_serial_port
 
-from serial.tools import list_ports
 from cryptography import x509
 from cryptography.hazmat.primitives import serialization
 
@@ -420,15 +418,8 @@ def main(in_args):
                                                     else 'generic device')))
 
         # try to open the serial port
-        try:
-            ser = serial.Serial(port, args.baud, xonxoff= args.xonxoff, rtscts=(not args.rtscts_off),
-                                dsrdtr=args.dsrdtr, timeout=serial_timeout)
-            ser.reset_input_buffer()
-            ser.reset_output_buffer()
-        except serial.serialutil.SerialException:
-            sys.stderr.write(error_style('Port could not be opened; not a device, or open already\n'))
-            sys.exit(5)
-
+        ser = get_serial_port(port, args.baud, xonxoff= args.xonxoff, rtscts=(not args.rtscts_off),
+                            dsrdtr=args.dsrdtr)
         # for gateways, get to the AT command prompt first
         if is_gateway:
             print(local_style('Getting to prompt...'))

src/nrfcloud_utils/gather_attestation_tokens.py

@@ -8,13 +8,11 @@
 import csv
 import time
 import json
-import serial
 import argparse
 import platform
 from nrfcloud_utils import modem_credentials_parser, rtt_interface
 from nrfcloud_utils.cli_helpers import is_linux, is_windows, is_macos
-from nrfcloud_utils.nordic_boards import ask_for_port
-from serial.tools import list_ports
+from nrfcloud_utils.nordic_boards import ask_for_port, get_serial_port
 from datetime import datetime, timezone
 from colorama import init, Fore, Back, Style
 
@@ -349,15 +347,8 @@ def main(in_args):
         print(local_style('Selected serial port: {}'.format(port)))
 
         # try to open the serial port
-        try:
-            ser = serial.Serial(port, args.baud, xonxoff= args.xonxoff, rtscts=(not args.rtscts_off),
-                            dsrdtr=args.dsrdtr, timeout=serial_timeout)
-            ser.reset_output_buffer()
-            write_line('')
-            time.sleep(0.2)
-            ser.reset_input_buffer()
-        except serial.serialutil.SerialException:
-            error_exit('Port could not be opened; not a device, or open already')
+        ser = get_serial_port(port, args.baud, xonxoff= args.xonxoff, rtscts=(not args.rtscts_off),
+                            dsrdtr=args.dsrdtr)
 
     # get attestation token
     attest_tok = get_attestation_token()

src/nrfcloud_utils/nordic_boards.py

@@ -1,6 +1,10 @@
 from serial.tools import list_ports
+import serial
 from collections import defaultdict
 import sys
+import time
+
+serial_timeout = 1
 
 # Some Nordic boards have their main serial port on the second interface.
 # Serial number prefix, display name, main_port
@@ -87,3 +91,16 @@ def ask_for_port(list_all):
             continue
         name, serial, port = ports[index]
         return port.device
+
+def get_serial_port(port, baud, xonxoff, rtscts, dsrdtr):
+    try:
+        ser = serial.Serial(port, baud, xonxoff= xonxoff, rtscts=rtscts,
+                        dsrdtr=dsrdtr, timeout=serial_timeout)
+        ser.reset_output_buffer()
+        ser.write(b'\r\n')
+        time.sleep(0.2)
+        ser.reset_input_buffer()
+    except serial.serialutil.SerialException:
+        sys.stderr.write('Port could not be opened; not a device, or open already.\n')
+        sys.exit(1)
+    return ser