Skip to content

Commit bc4d606

Browse files
committed
Add readme at root of each subsystem
1 parent a942779 commit bc4d606

File tree

3 files changed

+68
-0
lines changed

3 files changed

+68
-0
lines changed

Firmware/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Firmware Directory Structure
2+
3+
This directory will contain all of the firmware for the SAMD21 microcontroller used in the sensor board, as well for any other general MCUs used throughout testing.
4+
5+
***
6+
7+
## Common
8+
```
9+
Includes code that will be common across multiple projects, like sensor drivers and other peripheral drivers
10+
```
11+
***
12+
## Examples
13+
```
14+
Will include examples of applications of things like drivers and other pieces of firmware
15+
```
16+
***
17+
### WindTunnel, DTS, Vacuum
18+
```
19+
Will include project specific code like the main for each project.
20+
```
21+
***

Pidaq/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Raspberry Pi CPU Directory Structure
2+
3+
This directory contains all of the code that will run on the raspberry pi as well as all configuration for grafana and influxdb instances that will run on the pi.
4+
5+
***
6+
7+
## DataLogger
8+
```
9+
Generic name for python application that will log incoming data into influxdb
10+
```
11+
***
12+
## DataShuttle
13+
```
14+
Generic name for python application that will recieve and parse incoming CAN messages
15+
```
16+
***
17+
## Examples
18+
```
19+
Includes relevant examples for some python modules, influx, and grafana configuration
20+
```
21+
***
22+
## Services
23+
```
24+
Includes the configuration and documentation for the grafana server and influxdb
25+
```

UI/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Graphical User Interface Directory Structure
2+
3+
Contains all the code that implements a module graphical user interface that can be used differently depending on the desired project.
4+
5+
***
6+
7+
## Dashboard
8+
```
9+
Contains documentation and configuration for the grafana dashboard
10+
```
11+
***
12+
## Examples
13+
```
14+
Contains examples of grafana dashboard configuration
15+
```
16+
***
17+
## Control
18+
```
19+
Contains the web front end for the controls.
20+
```
21+
**Very Temporary**
22+
***

0 commit comments

Comments
 (0)