Merge pull request #2 from ParadigmHyperloop/feature/GE/dir-structure

colton-smith · web-flow · commit fc6f87d8fab6 · 2020-02-09T10:46:48.000-05:00
feature/GE/dir-structure
diff --git a/.gitignore b/.gitignore
diff --git a/ControlLaptop/DataLogger/main.py b/ControlLaptop/DataLogger/main.py
@@ -0,0 +1 @@
+# This file is intentionally left blank
diff --git a/ControlLaptop/DataShuttle/main.py b/ControlLaptop/DataShuttle/main.py
@@ -0,0 +1 @@
+# This file is intentionally left blank
diff --git a/ControlLaptop/Examples/example.py b/ControlLaptop/Examples/example.py
@@ -0,0 +1 @@
+# This file is intentionally left blank
diff --git a/ControlLaptop/README.md b/ControlLaptop/README.md
@@ -0,0 +1,25 @@
+
+# Control Laptop 
+This directory contains code that will run on the control laptop. The laptop will:
+-  Receive messages from the pi via UDP and         transmit commands via TCP. 
+- Store the receieved data in influxdb.
+- Serve grafana and influx
+- Communicate with the control GUI via socketio 
+
+## DataLogger
+Generic name for python application that will log incoming data into influxdb
+
+***
+## DataShuttle
+
+Generic name for python application that will recieve and parse incoming CAN messages - as well as send commands.
+
+***
+## Examples
+
+Includes relevant examples for some python modules, influx, and grafana configuration
+
+***
+## Services
+
+Includes the configuration and documentation for the grafana server and influxdb
diff --git a/ControlLaptop/Services/grafana/example.conf b/ControlLaptop/Services/grafana/example.conf
@@ -0,0 +1 @@
+# This file is intentionally left blank
diff --git a/ControlLaptop/Services/influxdb/example.conf b/ControlLaptop/Services/influxdb/example.conf
@@ -0,0 +1 @@
+# This file is intentionally left blank
diff --git a/ControlLaptop/UI/Control/css/example.css b/ControlLaptop/UI/Control/css/example.css
@@ -0,0 +1 @@
+/* This file is intentionally left blank
diff --git a/ControlLaptop/UI/Control/scripts/example.js b/ControlLaptop/UI/Control/scripts/example.js
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/ControlLaptop/UI/Control/static/example.html b/ControlLaptop/UI/Control/static/example.html
@@ -0,0 +1 @@
+<!-- This file is intentionally left blank -->
diff --git a/ControlLaptop/UI/Dashboards/example.conf b/ControlLaptop/UI/Dashboards/example.conf
@@ -0,0 +1 @@
+# This file is intentionally left blank
diff --git a/ControlLaptop/UI/Examples/example.conf b/ControlLaptop/UI/Examples/example.conf
@@ -0,0 +1 @@
+# This file is intentionally left blank
diff --git a/ControlLaptop/UI/README.md b/ControlLaptop/UI/README.md
@@ -0,0 +1,23 @@
+# Graphical User Interface Directory Structure
+
+Contains all the code that implements a module graphical user interface that can be used differently depending on the desired project.
+
+*** 
+
+## Dashboard
+
+Contains documentation and configuration for the grafana dashboard
+
+***
+## Examples
+
+Contains examples of grafana dashboard configuration
+
+
+***
+## Control
+
+Contains the web front end for the controls. 
+
+**Very Temporary** 
+***
diff --git a/Node/Common/actuators/inc/example.h b/Node/Common/actuators/inc/example.h
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Node/Common/actuators/src/example.cpp b/Node/Common/actuators/src/example.cpp
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Node/Common/drivers/inc/test.h b/Node/Common/drivers/inc/test.h
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Node/Common/drivers/src/test.cpp b/Node/Common/drivers/src/test.cpp
@@ -0,0 +1,2 @@
+// This file is intentionally left blank
+
diff --git a/Node/Common/sensors/inc/file.h b/Node/Common/sensors/inc/file.h
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Node/Common/sensors/src/file.cpp b/Node/Common/sensors/src/file.cpp
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Node/DTS/main.cpp b/Node/DTS/main.cpp
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Node/Examples/example1.cpp b/Node/Examples/example1.cpp
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Node/README.md b/Node/README.md
@@ -0,0 +1,19 @@
+# Embedded Software Directory 
+
+This directory will contain all of the firmware for the SAMD21 microcontroller used in the sensor board, as well for any other general MCU boards used throughout testing, such as the stepper motor control board.
+
+*** 
+
+## Common
+
+Includes code that will be common across multiple projects, like sensor drivers and other peripheral drivers
+
+***
+## Examples
+Will include example applications of things like drivers / libraries 
+
+***
+### WindTunnel, DTS, Vacuum
+Will include project specific code, like the respective main.cpp
+
+***
diff --git a/Node/Vacuum/main.cpp b/Node/Vacuum/main.cpp
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Node/WindTunnel/main.cpp b/Node/WindTunnel/main.cpp
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Pidaq/Examples/example1.py b/Pidaq/Examples/example1.py
@@ -0,0 +1 @@
+# This file is intentionally left blank
diff --git a/Pidaq/Inc/test.h b/Pidaq/Inc/test.h
@@ -0,0 +1 @@
+// This file is intentionally left blank
diff --git a/Pidaq/README.md b/Pidaq/README.md
@@ -0,0 +1,8 @@
+# Pidaq (Rasp Pi Data Aquisitor) 
+
+This directory contains all of the code that will run on the raspberry pi. The pi will receive and parse CAN messages containing raw telemetry, apply calculations,  and create a packet(s) containing either a JSON or protobuf message to send to the control laptop via ethernet (UDP)
+*** 
+## Examples
+
+Includes relevant examples 
+***
diff --git a/Pidaq/Src/test.cpp b/Pidaq/Src/test.cpp
@@ -0,0 +1 @@
+// This file is intentionally left blank

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# This file is intentionally left blank`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+/* This file is intentionally left blank`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+// This file is intentionally left blank`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!-- This file is intentionally left blank -->`