Eamples: Added support for --range and --log command line arguments in the s500, omniscan450, and surveyor240 examples.

Author: BradG13531

.gitignore

@@ -11,3 +11,4 @@ brping/s500.py
 brping/surveyor240.py
 brping/omniscan450.py
 doc/xml
+examples/logs

examples/omniscan450Example.py

@@ -0,0 +1,170 @@
+#!/usr/bin/env python
+
+#simpleOmniscan450Example.py
+from brping import definitions
+from brping import Omniscan450
+from brping import PingMessage
+import time
+import argparse
+
+from builtins import input
+
+import signal
+import sys
+import os
+from datetime import datetime
+
+##Parse Command line options
+############################
+
+parser = argparse.ArgumentParser(description="Ping python library example.")
+parser.add_argument('--device', action="store", required=False, type=str, help="Ping device port. E.g: /dev/ttyUSB0")
+parser.add_argument('--baudrate', action="store", type=int, default=115200, help="Ping device baudrate. E.g: 115200")
+parser.add_argument('--udp', action="store", required=False, type=str, help="Omniscan IP:Port. E.g: 192.168.2.92:51200")
+parser.add_argument('--tcp', action="store", required=False, type=str, help="Omniscan IP:Port. E.g: 192.168.2.92:51200")
+parser.add_argument('--range', action="store", required=False, type=str, help="Set range. E.g: 5000 or 0:5000")
+parser.add_argument('--log', action="store", nargs='?', const=True, type=str, help="Log filename. Will log if it doesn't exist, or replay if it does. Blank creates new log.")
+args = parser.parse_args()
+if args.device is None and args.udp is None and args.tcp is None and args.log is None:
+    parser.print_help()
+    exit(1)
+
+# Signal handler to stop pinging on the Omniscan450
+def signal_handler(sig, frame):
+    print("Stopping pinging on Omniscan450...")
+    myOmniscan450.control_os_ping_params(enable=0)
+    if myOmniscan450.iodev:
+        try:
+            myOmniscan450.iodev.close()
+        except Exception as e:
+            print(f"Failed to close socket: {e}")
+    sys.exit(0)
+
+signal.signal(signal.SIGINT, signal_handler)
+
+# Make a new Omniscan450
+myOmniscan450 = Omniscan450()
+if args.device is not None:
+    myOmniscan450.connect_serial(args.device, args.baudrate)
+elif args.udp is not None:
+    (host, port) = args.udp.split(':')
+    myOmniscan450.connect_udp(host, int(port))
+elif args.tcp is not None:
+    (host, port) = args.tcp.split(':')
+    myOmniscan450.connect_tcp(host, int(port)) 
+
+# Check for log argument
+# If no log is specified, create one using date and time
+# If a log is specified, existing log will be opened
+new_log = False
+if args.log is not None:
+    if args.log is True:
+        log_filename = datetime.now().strftime("omniscan-%Y-%m-%d_%H-%M-%S.txt")
+    elif isinstance(args.log, str):
+        log_filename = args.log
+    else:
+        log_filename = None
+    
+    if log_filename:
+        log_path = os.path.join("logs/omniscan", log_filename)
+        if os.path.exists(log_path):
+            print(f"Replaying from existing log file: {log_filename}")
+            new_log = False
+        else:
+            print(f"Logging to new file: {log_filename}")
+            new_log = True
+
+if args.log is None or new_log:
+    if myOmniscan450.initialize() is False:
+        print("Failed to initialize Omniscan450!")
+        exit(1)
+
+    data1 = myOmniscan450.get_device_information()
+    print("Device type: %s" % data1["device_type"])
+
+print("------------------------------------")
+print("Starting Omniscan450..")
+print("Press CTRL+C to exit")
+print("------------------------------------")
+
+input("Press Enter to continue...")
+
+# Running Omniscan from existing log file
+if args.log is not None and not new_log:
+    os.makedirs("logs/omniscan", exist_ok=True)
+    log_path = os.path.join("logs/omniscan", log_filename)
+    with open(log_path, 'rb') as f:
+        raw_bytes = f.read()
+        data = PingMessage(msg_data=raw_bytes)
+
+    if data:
+        scaled_result = Omniscan450.scale_power(data)
+        for i in range(len(scaled_result)):
+            print(f"{i+1}: Raw: {data.pwr_results[i]}\tScaled: {scaled_result[i]}dB")
+        print(f"Min power: {data.min_pwr_db} dB")
+        print(f"Max power: {data.max_pwr_db} dB")
+    else:
+        print("Failed to get report")
+
+# Connected to physical omniscan
+else:
+    if args.range is not None:
+        parts = args.range.split(':')
+
+        if len(parts) == 2:
+            myOmniscan450.control_os_ping_params(
+            start_mm=int(parts[0]),
+            length_mm=int(parts[1]),
+            enable=1
+        )
+        elif len(parts) == 1:
+            myOmniscan450.control_os_ping_params(
+                start_mm=0,
+                length_mm=int(parts[0]),
+                enable=1
+            )
+        else:
+            print("Invalid range input, using default range")
+            myOmniscan450.control_os_ping_params(enable=1)
+    else: 
+        # For default settings, just set enable pinging
+        myOmniscan450.control_os_ping_params(enable=1)
+
+    # For a custom ping rate
+    custom_msec_per_ping = Omniscan450.calc_msec_per_ping(1000)    # 1000 Hz
+
+    # To find pulse length percent
+    custom_pulse_length = Omniscan450.calc_pulse_length_pc(0.2)    # 0.2%
+
+    ## Set these attributes like this
+    # myOmniscan450.control_os_ping_params(
+    #     msec_per_ping=custom_msec_per_ping,
+    #     pulse_len_percent=custom_pulse_length,
+    #     num_results=200,
+    #     enable=1
+    # )
+
+    # View power results
+    data = myOmniscan450.wait_message([definitions.OMNISCAN450_OS_MONO_PROFILE])
+    if data:
+        scaled_result = Omniscan450.scale_power(data)
+        for i in range(len(scaled_result)):
+            print(f"{i+1}: Raw: {data.pwr_results[i]}\tScaled: {scaled_result[i]}dB")
+        print(f"Min power: {data.min_pwr_db} dB")
+        print(f"Max power: {data.max_pwr_db} dB")
+    else:
+        print("Failed to get report")
+
+    # Disable pinging and close socket
+    myOmniscan450.control_os_ping_params(enable=0)
+    if myOmniscan450.iodev:
+            try:
+                myOmniscan450.iodev.close()
+            except Exception as e:
+                print(f"Failed to close socket: {e}")
+
+    if new_log:
+        os.makedirs("logs/omniscan", exist_ok=True)
+        log_path = os.path.join("logs/omniscan", log_filename)
+        with open(log_path, 'ab') as f:
+            f.write(data.msg_data)