Abr asair sensor #14445

rclarke0 · 2024-02-07T21:35:21Z

Overview

This PR adds a script to the hardware-testing folder that will allow the robot to connect to an asair temperature and humidity sensor and record continuously to a google spread sheet.

Test Plan

I tested this script on robot DVT10 on software v7.1.1. It successfully measured the temperature and humidity and uploaded to the google sheet.

Changelog

Added abr-asair-sensor script
Script:

Asks user for robot name
Asks user for duration of recording (min)
Asks user for frequency of recording (min)
Robot reads ports and connects to asair sensor
robot collects data and appends to a list at the given frequency
At the end of the duration the robot saves a .csv file of the data to the testing-data folder within the robot and to the google sheet
I also updated the analyze-abr script to improve ease of analysis.

IMPORTANT: MAKE SURE ANY BREAKING CHANGES ARE PROPERLY COMMUNICATED
-->

Review requests

Risk assessment

for the script to run successfully on the robot, google_sheets_tool.py and a google sheets credentials file needs to be uploaded manually onto the robot's jupyter notebook.
for google_sheets_tool.py to run successfully within the script python libraries: httplib2, oauth2client, gspread, and pprintpp need to be installed onto the robots

codecov · 2024-02-08T17:36:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.14%. Comparing base (5fffd3e) to head (8e55ce9).
Report is 84 commits behind head on edge.

❗ Current head 8e55ce9 differs from pull request most recent head e0de99a. Consider uploading reports for the commit e0de99a to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             edge   #14445      +/-   ##
==========================================
- Coverage   68.15%   68.14%   -0.02%     
==========================================
  Files        1628     2518     +890     
  Lines       54954    72009   +17055     
  Branches     4141     9232    +5091     
==========================================
+ Hits        37452    49067   +11615     
- Misses      16814    20743    +3929     
- Partials      688     2199    +1511

Flag	Coverage Δ
hardware-testing	`∅ <ø> (∅)`

Flags with carried forward coverage won't be shown. Click here to find out more.

see 890 files with indirect coverage changes

sfoster1 · 2024-02-09T16:02:20Z

hardware-testing/hardware_testing/scripts/abr_asair_sensor.py

+    )
+
+
+def _get_user_input(list: List, some_string: str) -> str:


list is actually a predefined term in python - it is the name of the list type. defining a variable called list will shadow the global name in the scope where the variable is defined, which would lead to surprising results if you wanted to build a list in this function. Would you mind calling this something else, like lst or input_list or something?

changed to lst

sfoster1 · 2024-02-09T16:02:58Z

hardware-testing/hardware_testing/scripts/abr_asair_sensor.py

+    )
+
+
+def _get_user_input(list: List, some_string: str) -> str:


Unrelatedly, List is a generic container type that is meant to be specialized with the type it contains - for instance, List[str] is a list of strings, List[int] is a list of ints.

added List[str]

sfoster1 · 2024-02-09T16:03:51Z

hardware-testing/hardware_testing/scripts/abr_asair_sensor.py

+    return variable
+
+
+class _abr_asair_sensor:


fyi, common python style is for classes to be PascalCase - in this case, _ABRAsairSensor if the class isn't meant to be exported and ABRAsairSensor if it is

changed class name _ABRAsairSensor

andySigler

This is awesome. Just a few comments that shouldn't block merging

andySigler · 2024-02-28T18:07:32Z

hardware-testing/hardware_testing/scripts/abr_asair_sensor.py

+        while True:
+            env_data = sensor.get_reading()
+            timestamp = datetime.datetime.now()
+            new_timestamp = timestamp - datetime.timedelta(hours=5)


is this b/c of the timezone? either leaving a comment to describe what this is doing or somehow specifying the system's timezone would make it more clear

andySigler · 2024-02-28T18:15:30Z

hardware-testing/hardware_testing/scripts/abr_asair_sensor.py

+        for sublist in results_list:
+            row_str = ", ".join(map(str, sublist)) + "\n"  # type: str
+            result_string += row_str
+            save_file_path = data.append_data_to_file(


here you are appending the line to all previous lines, and then you appending that string to the file, and doing this for each line, which means that the file you are writing will be huge and filled with repeated lines.

This can be fixed by removing the result_string variable and just passing the row_str into append_data_to_file().

Then also, you can append each line to the CSV at the same time that you write the data to the google sheet. Just move the append_data_to_file() up into while loop above. Then the CSV will be updated in realtime, plus you don't need to store data in the results_list variable anymore.

# Overview This PR adds a script to the hardware-testing folder that will allow the robot to connect to an asair temperature and humidity sensor and record continuously to a google spread sheet. # Test Plan I tested this script on robot DVT10 on software v7.1.1. It successfully measured the temperature and humidity and uploaded to the google sheet. # Changelog Added abr-asair-sensor script Script: 1. Asks user for robot name 2. Asks user for duration of recording (min) 3. Asks user for frequency of recording (min) 4. Robot reads ports and connects to asair sensor 5. robot collects data and appends to a list at the given frequency 6. At the end of the duration the robot saves a .csv file of the data to the testing-data folder within the robot and to the google sheet I also updated the analyze-abr script to improve ease of analysis. IMPORTANT: MAKE SURE ANY BREAKING CHANGES ARE PROPERLY COMMUNICATED --> # Review requests  # Risk assessment - for the script to run successfully on the robot, google_sheets_tool.py and a google sheets credentials file needs to be uploaded manually onto the robot's jupyter notebook. - for google_sheets_tool.py to run successfully within the script python libraries: httplib2, oauth2client, gspread, and pprintpp need to be installed onto the robots

rclarke0 added 4 commits February 7, 2024 16:00

abr_asair_sensor script

1f6b411

abr_asaor_sensor script

9c04a10

removing mechanical testing foldeR

879aaf1

removing extra deck definition file

d728581

rclarke0 requested a review from a team as a code owner February 7, 2024 21:35

fixing lint issues

0e88345

rclarke0 requested a review from andySigler February 7, 2024 21:54

changed script to write each reading instead of all at the end

3a9e9bc

rclarke0 added 2 commits February 8, 2024 14:23

fixed lint issues and reduced print outs

ce1b8fa

updatedlint changes

23559be

sfoster1 reviewed Feb 9, 2024

View reviewed changes

rclarke0 added 2 commits February 12, 2024 13:42

fixed-syntax-comments

ea23e72

compatibility-with-computer

6561b8f

rclarke0 requested a review from a team as a code owner February 26, 2024 19:47

removing google sheets tools

8e55ce9

rclarke0 requested a review from sfoster1 February 27, 2024 15:59

andySigler approved these changes Feb 28, 2024

View reviewed changes

rclarke0 added 2 commits February 28, 2024 16:39

updated csv to log in real time, commented time diff with robots

7b51761

added space

e0de99a

rclarke0 merged commit 2c5932f into edge Feb 28, 2024
6 checks passed

rclarke0 deleted the abr-asair-sensor branch February 28, 2024 21:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Abr asair sensor #14445

Abr asair sensor #14445

rclarke0 commented Feb 7, 2024

codecov bot commented Feb 8, 2024 •

edited

Loading

sfoster1 Feb 9, 2024

rclarke0 Feb 12, 2024

sfoster1 Feb 9, 2024

rclarke0 Feb 12, 2024

sfoster1 Feb 9, 2024

rclarke0 Feb 12, 2024

andySigler left a comment

andySigler Feb 28, 2024

andySigler Feb 28, 2024

Abr asair sensor #14445

Abr asair sensor #14445

Conversation

rclarke0 commented Feb 7, 2024

Overview

Test Plan

Changelog

Review requests

Risk assessment

codecov bot commented Feb 8, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andySigler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Feb 8, 2024 •

edited

Loading