From 2044d6b94d328bc30fe2d106889166f243e7b4c3 Mon Sep 17 00:00:00 2001
From: Rhyann Clarke <146747548+rclarke0@users.noreply.github.com>
Date: Mon, 4 Mar 2024 14:44:58 -0500
Subject: [PATCH] Shenzhen Scale Script (#14583)

<!--
Thanks for taking the time to open a pull request! Please make sure
you've read the "Opening Pull Requests" section of our Contributing
Guide:


https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-pull-requests

To ensure your code is reviewed quickly and thoroughly, please fill out
the sections below to the best of your ability!
-->

# Overview

Use Scale in Shenzhen to get stable reading

# Test Plan

<!--
tested script on the ABR scale multiple times.

-->

# Changelog
Looks for scale
Asks user to select port if not found
Reads stable_value, mass
Logs stable_value, mass to csv
stops logging when stable value is reached.
Asks user if they want to weigh another sample
IF yes creates a new file path and restarts the weighing process

# Review requests

<!--
Describe any requests for your reviewers here.
-->

# Risk assessment
---
 .../scripts/get_stable_scale_reading.py       | 62 +++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 hardware-testing/hardware_testing/scripts/get_stable_scale_reading.py

diff --git a/hardware-testing/hardware_testing/scripts/get_stable_scale_reading.py b/hardware-testing/hardware_testing/scripts/get_stable_scale_reading.py
new file mode 100644
index 00000000000..480929cad53
--- /dev/null
+++ b/hardware-testing/hardware_testing/scripts/get_stable_scale_reading.py
@@ -0,0 +1,62 @@
+"""Shenzhen Scale."""
+import datetime
+from hardware_testing import data
+from typing import List
+from hardware_testing.drivers import find_port, list_ports_and_select
+from hardware_testing.drivers.radwag import RadwagScale
+
+
+def _create_scale_reading_file() -> List[str]:
+    test_name = "TC_Evaporation"
+    run_id = data.create_run_id()
+    tag = ""
+    file_name = data.create_file_name(test_name, run_id, tag)
+    header = ["Date", "Scale Reading", "Stable"]
+    header_str = ",".join(header) + "\n"
+    data.append_data_to_file(
+        test_name=test_name, run_id=run_id, file_name=file_name, data=header_str
+    )
+    save_file_variables = [test_name, run_id, file_name]
+    return save_file_variables
+
+
+if __name__ == "__main__":
+    # find port using known VID:PID, then connect
+    vid, pid = RadwagScale.vid_pid()
+    try:
+        scale = RadwagScale.create(port=find_port(vid=vid, pid=pid))
+    except RuntimeError:
+        device = list_ports_and_select()
+        scale = RadwagScale.create(device)
+    scale.connect()
+    is_stable = False
+    save_file_variables = _create_scale_reading_file()
+    results_list = []
+    break_all = False
+    while is_stable is False:
+        grams, is_stable = scale.read_mass()
+        print(f"Scale reading: grams={grams}, is_stable={is_stable}")
+        time_now = datetime.datetime.now()
+        row = [time_now, grams, is_stable]
+        results_list.append(row)
+        while is_stable is True:
+            print(f"Scale stable reading {grams}.")
+            result_string = ""
+            for sublist in results_list:
+                row_str = ", ".join(map(str, sublist)) + "\n"
+                result_string += row_str
+            file_path = data.append_data_to_file(
+                save_file_variables[0],
+                save_file_variables[1],
+                save_file_variables[2],
+                result_string,
+            )
+            is_stable = False
+            y_or_no = input("Do you want to weight another sample? (Y/N): ")
+            if y_or_no == "Y":
+                is_stable = False
+                save_file_variables = _create_scale_reading_file()
+            elif y_or_no == "N":
+                break_all = True
+        if break_all:
+            break