HART-Avionics · Samuel-Villegas · Nov 29, 2020 · Feb 18, 2021 · Mar 20, 2021 · Mar 23, 2021
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -15,6 +15,8 @@ If you want to add a few quick changes or are adding changes related to an issue
 
 1. Fork the repository
 2. Make your changes
-3. Use the `.github/PULL_REQUEST_TEMPLATE.md` to create a pull request describing your changes
+3. Use the [`.github/PULL_REQUEST_TEMPLATE.md`][PR-template] to create a pull request describing your changes
 
 Otherwise, please use the `.github/ISSUE_TEMPLATE.md` to create a new `Feature Request` issue and include a comment requesting to be assigned to that issue.
+
+[PR-template]: PULL_REQUEST_TEMPLATE/pull_request_template.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/...REQUEST_TEMPLATE/pull_request_template.md → .github/PULL_REQUEST_TEMPLATE.md b/...REQUEST_TEMPLATE/pull_request_template.md → .github/PULL_REQUEST_TEMPLATE.md
diff --git a/ProjectCharter.pdf b/ProjectCharter.pdf
diff --git a/README.md b/README.md
@@ -64,7 +64,7 @@ $ sudo apt-get install texlive-latex-recommended texlive-fonts-recommended texli
 ### Installing
 1. Clone the repo
     ```bash
-    $> git clone https://github.com/HART-Avionics/docs.git
+    $ git clone https://github.com/HART-Avionics/docs.git
     ```
 
 <a name="usage"></a>

diff --git a/docs/conf.py b/docs/conf.py
@@ -31,7 +31,8 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-  'recommonmark'
+  'recommonmark',
+  'sphinx.ext.intersphinx'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/images/schematic.png b/docs/images/schematic.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,5 +7,6 @@ Welcome to HART Avionics's documentation!
    introduction
    overview
    events
-   project_structure/Structure
+   ../.github/CONTRIBUTING
+   project_structure/ProjectStructure
    contributing
diff --git a/...tructure/1.0_avionics/1.1_flight_system/1.1.1_flight_hardware/FlightHardware.md b/...tructure/1.0_avionics/1.1_flight_system/1.1.1_flight_hardware/FlightHardware.md
@@ -0,0 +1,15 @@
+Flight Hardware
+================
+
+Primary Flight Controller
+--------------------------
+Telemega
+
+Backup Flight Controller
+----------------------------
+Easymega
+
+Power
+------
+3.7v LiPo battery for each flight controller
+
diff --git a/...tructure/1.0_avionics/1.1_flight_system/1.1.2_flight_software/FlightSoftware.md b/...tructure/1.0_avionics/1.1_flight_system/1.1.2_flight_software/FlightSoftware.md
@@ -0,0 +1,4 @@
+Flight Software
+================
+AltOS
+
diff --git a/docs/project_structure/1.0_avionics/1.1_flight_system/FlightSystem.rst b/docs/project_structure/1.0_avionics/1.1_flight_system/FlightSystem.rst
@@ -0,0 +1,12 @@
+Flight System
+==============
+The Flight System is the system of hardware & software that triggers the rocket events. For safety reasons, we are currently required to use commercially certified products to control the pyrotechnic events, but the plan is to eventually replace the commercial flight controllers with :doc:`one developed by HART <../1.2_payload/1.2.2_HART_flight_controller/FlightController>`.
+
+Both the booster and sustainer have an Altus Metrum TeleMega and EasyMega each. The EasyMega is just a TeleMega without any RF capabilities and will be serving as a backup flight computer. Both of these systems are running AltOS. For more information about Altus Metrum products, visit the [Altus Metrum website](https://altusmetrum.org/).
+
+.. toctree::
+    :maxdepth: 3
+
+    1.1.1_flight_hardware/FlightHardware
+    1.1.2_flight_software/FlightSoftware
+
diff --git a/.../project_structure/1.0_avionics/1.2_payload/1.2.1_payload_power/PayloadPower.md b/.../project_structure/1.0_avionics/1.2_payload/1.2.1_payload_power/PayloadPower.md
@@ -0,0 +1,4 @@
+Payload Power
+==============
+Powers the payload systems
+
diff --git a/...cture/1.0_avionics/1.2_payload/1.2.2_HART_flight_controller/FlightController.md b/...cture/1.0_avionics/1.2_payload/1.2.2_HART_flight_controller/FlightController.md
@@ -0,0 +1,40 @@
+HART Flight Controller
+=======================
+<!-- Block Definition -->
+The HART Flight Controller is the student-developed flight computer currently under development. For more information on the HART Flight Controller, please refer to the [Flight Controller repository][hardware-repository]. For more information on the software for the HART Flight Controller, please refer to the [Flight Software repository][software-repository].
+
+![Flight Controller Schematic][schematic]
+
+Basic Requirements
+-------------------
+The most basic requirements of a rocket avionics system are triggering events and tracking the rocket. Tracking the rocket will be how we determine if the rocket reached its goal altitude or not. There are several ways in which this step could go wrong or produce incorrect results, so redundancy and rigorous testing should be preferred. In addition to this, the rocket’s avionics system must be able to trigger events under the right conditions in order to maximize the chances of reaching higher altitudes and, more importantly, the chances of successfully recovering the rocket.
+
+Inputs
+--------
+- Environment (External)
+  - Acceleration
+    - Max: 50 G
+  - Altitude
+  - Attitude (pose/orientation)
+  - GPS data
+  - Magnetic Field
+  - Temperature
+- Power Systems
+  - Vmin: 3.3 V
+  - Vnominal: 3.7 V
+  - Vmax: 16 V
+
+Outputs
+---------
+- Ground Station GUI Server
+  - Flight data structure matches AltOS data structure
+
+Block Properties
+-----------------
+For safety reasons, we are currently required to use commercially certified products to control the pyrotechnic events, but the plan is to eventually replace the commercial flight controllers with this student-developed solution.
+
+<!-- Links -->
+[hardware-repository]: https://github.com/HART-Avionics/OSU-HART-Flight-Controller
+[software-repository]: https://github.com/HART-Avionics/OSU-HART-Flight-Software
+[schematic]:../../../../images/schematic.png "Schematic"
+
diff --git a/...llection_and_recovery_systems/1.2.3.1_pressure_transducer/PressureTransducer.md b/...llection_and_recovery_systems/1.2.3.1_pressure_transducer/PressureTransducer.md
@@ -0,0 +1,11 @@
+Pressure Transducer
+====================
+
+Hardware
+---------
+TBD
+
+Software
+---------
+TBD
+
diff --git a/...d/2.2.2_tracking_beacon/TrackingBeacon.md → ..._systems/1.2.3.2_GPS_beacon/GPS_Beacon.md b/...d/2.2.2_tracking_beacon/TrackingBeacon.md → ..._systems/1.2.3.2_GPS_beacon/GPS_Beacon.md
@@ -3,13 +3,7 @@ Tracking Beacon
 <!-- Block Definition -->
 The Tracking Beacon provides a way to track the rocket for recovery in case the flight computer’s telemetry fails.
 
-Inputs
---------
-- Power Systems
+Properties
+-----------
+HART has a BigRedBee as well as TeleGPS for using as a GPS beacon.
 
-Outputs
----------
-- RF (External)
-
-Block Properties
------------------
diff --git a/...1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.3_camera/Camera.md b/...1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.3_camera/Camera.md
@@ -0,0 +1,9 @@
+Camera
+========
+<!-- Block Definition -->
+The camera records video of the flight through a small window in the side of the rocket.
+
+Properties
+-----------
+GoPro
+
diff --git a/...d/1.2.3_data_collection_and_recovery_systems/1.2.3.4_thermometer/Thermometer.md b/...d/1.2.3_data_collection_and_recovery_systems/1.2.3.4_thermometer/Thermometer.md
@@ -0,0 +1,7 @@
+Thermometer
+============
+The thermometer records the temperature throughout the flight in order to determine if the temperature inside the rocket is within the operating temperature of the electronic components or if the temperature changes during flight are significant enough to affect the rocket's state estimation. If the effects of temperature are significant enough, then the [HART Flight Controller][flight-controller-docs] will need to include a thermometer for more accurate state estimation.
+
+<!-- Links -->
+[flight-controller-docs]: ../../1.2.2_HART_flight_controller/FlightController.md
+
diff --git a/...1.2.3_data_collection_and_recovery_systems/DataCollectionAndRecoverySystems.rst b/...1.2.3_data_collection_and_recovery_systems/DataCollectionAndRecoverySystems.rst
@@ -0,0 +1,22 @@
+Data Collection & Recovery Systems
+===================================
+The Data Collection & Recovery Systems record data for post-flight analyses and help recover the rocket after launch. Data from these systems can help diagnose any issues that might have occurred during flight. However, there isn't a lot of space in the rocket. Extra hardware adds weight and cost, and there's always a chance that this hardware will not make it back in one piece, so choose payloads carefully.
+
+Examples of data collection & recovery systems include:
+
+- Motor temperature & pressure sensors
+- Flight-event detection (see :doc:`Sequence of Events <../../../../events>` for more details)
+- Engineering cameras and microphones
+- Dedicated state estimation modules
+- GPS beacons
+
+The current data collection & recovery systems are listed below. These include systems under development as well as commecially sourced systems we plan to use:
+
+.. toctree::
+   :maxdepth: 3
+
+   1.2.3.1_pressure_transducer/PressureTransducer
+   1.2.3.2_GPS_beacon/GPS_Beacon
+   1.2.3.3_camera/Camera
+   1.2.3.4_thermometer/Thermometer
+
diff --git a/...ture/2.0_avionics/2.2_payload/Payload.rst → ...ture/1.0_avionics/1.2_payload/Payload.rst b/...ture/2.0_avionics/2.2_payload/Payload.rst → ...ture/1.0_avionics/1.2_payload/Payload.rst
@@ -5,7 +5,7 @@ The payload refers to all the electronics onboard the rocket that are not respon
 .. toctree::
    :maxdepth: 3
 
-   2.2.1_HART_flight_computer/HART_FlightComputer
-   2.2.2_tracking_beacon/TrackingBeacon
-   2.2.3_rocket_vitals/RocketVitals
-   2.2.4_camera/Camera
+   1.2.1_payload_power/PayloadPower
+   1.2.2_HART_flight_controller/FlightController
+   1.2.3_data_collection_and_recovery_systems/DataCollectionAndRecoverySystems
+
diff --git a/...oject_structure/2.0_avionics/Avionics.rst → ...oject_structure/1.0_avionics/Avionics.rst b/...oject_structure/2.0_avionics/Avionics.rst → ...oject_structure/1.0_avionics/Avionics.rst
@@ -5,5 +5,6 @@ Avionics refers to all the software & electronics onboard the rocket.
 .. toctree::
    :maxdepth: 3
 
-   2.1_flight_computer/FlightComputer
-   2.2_payload/Payload
+   1.1_flight_system/FlightSystem
+   1.2_payload/Payload
+
diff --git a/docs/project_structure/1.0_power_systems/PowerSystems.md b/docs/project_structure/1.0_power_systems/PowerSystems.md
diff --git a/docs/project_structure/2.0_avionics/2.1_flight_computer/FlightComputer.md b/docs/project_structure/2.0_avionics/2.1_flight_computer/FlightComputer.md
diff --git a/...ture/2.0_avionics/2.2_payload/2.2.1_HART_flight_computer/HART_FlightComputer.md b/...ture/2.0_avionics/2.2_payload/2.2.1_HART_flight_computer/HART_FlightComputer.md
diff --git a/.../project_structure/2.0_avionics/2.2_payload/2.2.3_rocket_vitals/RocketVitals.md b/.../project_structure/2.0_avionics/2.2_payload/2.2.3_rocket_vitals/RocketVitals.md
diff --git a/docs/project_structure/2.0_avionics/2.2_payload/2.2.4_camera/Camera.md b/docs/project_structure/2.0_avionics/2.2_payload/2.2.4_camera/Camera.md
diff --git a/docs/project_structure/2.0_ground_systems/2.1_ignition_box/IgnitionBox.md b/docs/project_structure/2.0_ground_systems/2.1_ignition_box/IgnitionBox.md
@@ -0,0 +1,15 @@
+Ignition Box
+=============
+<!-- Block Definition -->
+The Ignition Box ignites the rocket booster when launch signal is received from the Control Box.
+
+Inputs
+--------
+- Launch Communications
+
+Outputs
+---------
+- Booster E-Match (External)
+
+Block Properties
+---------------------------