From 76efc08d8ff30becd6a80fd993388da8b02e048e Mon Sep 17 00:00:00 2001 From: Tyrel Souza Date: Thu, 17 Nov 2022 13:51:27 -0500 Subject: [PATCH] Update readme - try to explain some bits of the code --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d80b8bd..6d4c470 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# 8082_Waymo_PC_2022-07-24 \ No newline at end of file +# 8082_Waymo_PC_2022-07-24 + + +Copyright Benchtop Devices. + + +## File Structure + + +### FlexFlowXML.cs + +Creates an XML Envelope for sending to Flextronics.com/FFTester20 (SOAP) + +### I28FlexStatus.cs + +Sets error codes for the class instance with a switch statement based on the I28 Status + +### SaveResult.cs + +#### SaveResult Class +Main controlling class, stores information about the station, parameters, and test results. + +Writes to file for Dumpy to upload. + +#### SaveResultResponse Class + +Parses responses from Flexflow to show to the UI + + +### Form1.cs + +UI and Serial interaction. + + + +