diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index cda4149..526a334 100644 --- 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ 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 new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ 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/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/PULL_REQUEST_TEMPLATE.md diff --git a/ProjectCharter.pdf b/ProjectCharter.pdf deleted file mode 100644 index 43b1305..0000000 Binary files a/ProjectCharter.pdf and /dev/null differ diff --git a/README.md b/README.md index 766256e..536fa9e 100644 --- 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 ``` diff --git a/docs/conf.py b/docs/conf.py index 2a0b182..400761b 100644 --- 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 new file mode 100644 index 0000000..add1075 Binary files /dev/null and b/docs/images/schematic.png differ diff --git a/docs/index.rst b/docs/index.rst index 676bd4c..1fb7667 100644 --- 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/docs/project_structure/1.0_avionics/1.1_flight_system/1.1.1_flight_hardware/FlightHardware.md b/docs/project_structure/1.0_avionics/1.1_flight_system/1.1.1_flight_hardware/FlightHardware.md new file mode 100644 index 0000000..e7f3c9f --- /dev/null +++ b/docs/project_structure/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/docs/project_structure/1.0_avionics/1.1_flight_system/1.1.2_flight_software/FlightSoftware.md b/docs/project_structure/1.0_avionics/1.1_flight_system/1.1.2_flight_software/FlightSoftware.md new file mode 100644 index 0000000..8ad2f79 --- /dev/null +++ b/docs/project_structure/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 new file mode 100644 index 0000000..811f4fc --- /dev/null +++ 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/docs/project_structure/1.0_avionics/1.2_payload/1.2.1_payload_power/PayloadPower.md b/docs/project_structure/1.0_avionics/1.2_payload/1.2.1_payload_power/PayloadPower.md new file mode 100644 index 0000000..2a5981d --- /dev/null +++ b/docs/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/docs/project_structure/1.0_avionics/1.2_payload/1.2.2_HART_flight_controller/FlightController.md b/docs/project_structure/1.0_avionics/1.2_payload/1.2.2_HART_flight_controller/FlightController.md new file mode 100644 index 0000000..38462e8 --- /dev/null +++ b/docs/project_structure/1.0_avionics/1.2_payload/1.2.2_HART_flight_controller/FlightController.md @@ -0,0 +1,40 @@ +HART Flight Controller +======================= + +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. + + +[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/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.1_pressure_transducer/PressureTransducer.md b/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.1_pressure_transducer/PressureTransducer.md new file mode 100644 index 0000000..8524adb --- /dev/null +++ b/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.1_pressure_transducer/PressureTransducer.md @@ -0,0 +1,11 @@ +Pressure Transducer +==================== + +Hardware +--------- +TBD + +Software +--------- +TBD + diff --git a/docs/project_structure/2.0_avionics/2.2_payload/2.2.2_tracking_beacon/TrackingBeacon.md b/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.2_GPS_beacon/GPS_Beacon.md similarity index 63% rename from docs/project_structure/2.0_avionics/2.2_payload/2.2.2_tracking_beacon/TrackingBeacon.md rename to docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.2_GPS_beacon/GPS_Beacon.md index f32cd6d..f51d185 100644 --- a/docs/project_structure/2.0_avionics/2.2_payload/2.2.2_tracking_beacon/TrackingBeacon.md +++ b/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.2_GPS_beacon/GPS_Beacon.md @@ -3,13 +3,7 @@ Tracking Beacon 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/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.3_camera/Camera.md b/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.3_camera/Camera.md new file mode 100644 index 0000000..a9f30e9 --- /dev/null +++ b/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.3_camera/Camera.md @@ -0,0 +1,9 @@ +Camera +======== + +The camera records video of the flight through a small window in the side of the rocket. + +Properties +----------- +GoPro + diff --git a/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.4_thermometer/Thermometer.md b/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/1.2.3.4_thermometer/Thermometer.md new file mode 100644 index 0000000..f3165a9 --- /dev/null +++ b/docs/project_structure/1.0_avionics/1.2_payload/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. + + +[flight-controller-docs]: ../../1.2.2_HART_flight_controller/FlightController.md + diff --git a/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/DataCollectionAndRecoverySystems.rst b/docs/project_structure/1.0_avionics/1.2_payload/1.2.3_data_collection_and_recovery_systems/DataCollectionAndRecoverySystems.rst new file mode 100644 index 0000000..2d4d37d --- /dev/null +++ b/docs/project_structure/1.0_avionics/1.2_payload/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/docs/project_structure/2.0_avionics/2.2_payload/Payload.rst b/docs/project_structure/1.0_avionics/1.2_payload/Payload.rst similarity index 50% rename from docs/project_structure/2.0_avionics/2.2_payload/Payload.rst rename to docs/project_structure/1.0_avionics/1.2_payload/Payload.rst index e9d0bec..68081d2 100644 --- a/docs/project_structure/2.0_avionics/2.2_payload/Payload.rst +++ b/docs/project_structure/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/docs/project_structure/2.0_avionics/Avionics.rst b/docs/project_structure/1.0_avionics/Avionics.rst similarity index 66% rename from docs/project_structure/2.0_avionics/Avionics.rst rename to docs/project_structure/1.0_avionics/Avionics.rst index 55a57b9..3e3ce99 100644 --- a/docs/project_structure/2.0_avionics/Avionics.rst +++ b/docs/project_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 deleted file mode 100644 index 382cda7..0000000 --- a/docs/project_structure/1.0_power_systems/PowerSystems.md +++ /dev/null @@ -1,15 +0,0 @@ -Power Systems -============== - -The power systems power the electronics. - -Inputs -------- -- - -Outputs --------- -- 3.3V or 5V to the microcontrollers. - -Block Properties ------------------ 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 deleted file mode 100644 index 545eece..0000000 --- a/docs/project_structure/2.0_avionics/2.1_flight_computer/FlightComputer.md +++ /dev/null @@ -1,31 +0,0 @@ -Flight Computer -================ - -The Flight Computer is the hardware & software that triggers the rocket events. - -Inputs --------- -- Environment (External) - - Acceleration - - Max: 50 G - - Altitude - - Attitude (pose/orientation) - - GPS data - - Magnetic Field - - Temperature -- Power Systems - - Vmin: 3 V - - Vnominal: 3.7 V - - Vmax: 16 V - -Outputs ---------- -- Pyro Charges (External) - - Vmin: 4 V - - Vnominal: 12 V - - Vmax: 16 V -- Ground Station Transceiver - -Block Properties ---------------------------- -We are currently required to use a commercial solution. 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/). diff --git a/docs/project_structure/2.0_avionics/2.2_payload/2.2.1_HART_flight_computer/HART_FlightComputer.md b/docs/project_structure/2.0_avionics/2.2_payload/2.2.1_HART_flight_computer/HART_FlightComputer.md deleted file mode 100644 index e4f6e1b..0000000 --- a/docs/project_structure/2.0_avionics/2.2_payload/2.2.1_HART_flight_computer/HART_FlightComputer.md +++ /dev/null @@ -1,28 +0,0 @@ -HART Flight Computer -===================== - -The HART Flight Computer is the student-developed flight computer currently under development. - -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 ------------------ -We are currently required to use commercially available products to control the rocket events, but the plan is to eventually replace the commercially-developed flight computers with a student-developed solution. diff --git a/docs/project_structure/2.0_avionics/2.2_payload/2.2.3_rocket_vitals/RocketVitals.md b/docs/project_structure/2.0_avionics/2.2_payload/2.2.3_rocket_vitals/RocketVitals.md deleted file mode 100644 index ca42b63..0000000 --- a/docs/project_structure/2.0_avionics/2.2_payload/2.2.3_rocket_vitals/RocketVitals.md +++ /dev/null @@ -1,16 +0,0 @@ -Rocket Vitals -=============== - -The Rocket Vitals monitor the rocket's internals, mostly for post-flight debugging. - -Inputs --------- -- - -Outputs ---------- -- - -Block Properties ---------------------------- -- Examples include motor temperature & pressure, stage-separation detection, parachute deployment detection, and dedicated state estimation 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 deleted file mode 100644 index 804e5d6..0000000 --- a/docs/project_structure/2.0_avionics/2.2_payload/2.2.4_camera/Camera.md +++ /dev/null @@ -1,15 +0,0 @@ -Camera -======== - -Record video through a window in the side of the rocket - -Inputs --------- -- - -Outputs ---------- -- - -Block Properties ---------------------------- 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 new file mode 100644 index 0000000..908131b --- /dev/null +++ b/docs/project_structure/2.0_ground_systems/2.1_ignition_box/IgnitionBox.md @@ -0,0 +1,15 @@ +Ignition Box +============= + +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 +--------------------------- diff --git a/docs/project_structure/2.0_ground_systems/2.2_launch_transceiver/LaunchTransceiver.md b/docs/project_structure/2.0_ground_systems/2.2_launch_transceiver/LaunchTransceiver.md new file mode 100644 index 0000000..d1aeb27 --- /dev/null +++ b/docs/project_structure/2.0_ground_systems/2.2_launch_transceiver/LaunchTransceiver.md @@ -0,0 +1,24 @@ +Launch Transceiver +====================== + +The Launch Transceiver is the transceiver that manages the communication between the Control Box and the Ignition Box. The tranceiver in the Control Box must be programmed with the [Launch Control Software][launch-control-software-repo] and the transceiver in the Ignition Box must be programmed with the [Launch Ignition Software][lanch-ignition-software-repo]. + +Inputs +-------- +- +- +- + +Outputs +--------- +- +- +- + +Block Properties +--------------------------- + + +[launch-control-software-repo]: https://github.com/HART-Avionics/OSU-HART-Launch-Control-Software +[launch-ignition-software-repo]: https://github.com/HART-Avionics/OSU-HART-Launch-Ignition-Software + diff --git a/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.1_control_box_power/ControlBoxPower.md b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.1_control_box_power/ControlBoxPower.md new file mode 100644 index 0000000..1831713 --- /dev/null +++ b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.1_control_box_power/ControlBoxPower.md @@ -0,0 +1,13 @@ +Control Box Power +================== +The Control Box Power provides power for the Control Box subsystems. + +Outputs +-------- +- +- +- + +Block Properties +----------------- + diff --git a/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.2_user_interface/UserInterface.md b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.2_user_interface/UserInterface.md new file mode 100644 index 0000000..df567c9 --- /dev/null +++ b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.2_user_interface/UserInterface.md @@ -0,0 +1,16 @@ +Physical User Interface +======================== + +The Physical User Interface is user interface of the Control Box with the big red launch button as well as other switches and indicator lights. + +Inputs +-------- +- Physical User Interface (External) + +Outputs +--------- +- Launch Communications + +Block Properties +--------------------------- +- Big red button diff --git a/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.3_ground_telemetry/GroundTelemetry.md b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.3_ground_telemetry/GroundTelemetry.md new file mode 100644 index 0000000..6310ae7 --- /dev/null +++ b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.3_ground_telemetry/GroundTelemetry.md @@ -0,0 +1,19 @@ +Ground Telemetry +================= + +The Ground Telemetry communicates with the Avionics and relays the telemetry data to the Ground Computer. + +Inputs +-------- +- Avionics Telemetry (RF) + +Outputs +--------- +- Ground Computer (USB) + +Block Properties +--------------------------- +**Antenna**: Yagi antenna +**Cable**: Coaxial with BNC to Coaxial adapters +**Telemetry Interface**: TeleDongle + diff --git a/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.4_ground_computer/2.3.4.1_data_processing/DataProcessing.md b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.4_ground_computer/2.3.4.1_data_processing/DataProcessing.md new file mode 100644 index 0000000..9a4b899 --- /dev/null +++ b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.4_ground_computer/2.3.4.1_data_processing/DataProcessing.md @@ -0,0 +1,22 @@ +Data Processing +================ + +The Data Processing code saves telemetry for later use, processes the telemetry, and serves the processed data to the GUI Client. For more information, please refer to [the official Data Processing repository][data-processing-repo]. + +Inputs +-------- +- Simulation telemetry +- Live telemetry +- Saved telemetry + +Outputs +--------- +- + +Block Properties +--------------------------- + + + +[data-processing-repo]: https://github.com/HART-Avionics/OSU-HART-Data-Processing + diff --git a/docs/project_structure/4.0_ground_station/4.5_gui_client/GUI_Client.md b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.4_ground_computer/2.3.4.2_state_visualization/StateVisualization.md similarity index 100% rename from docs/project_structure/4.0_ground_station/4.5_gui_client/GUI_Client.md rename to docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.4_ground_computer/2.3.4.2_state_visualization/StateVisualization.md diff --git a/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.4_ground_computer/GroundComputer.rst b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.4_ground_computer/GroundComputer.rst new file mode 100644 index 0000000..f0c8d78 --- /dev/null +++ b/docs/project_structure/2.0_ground_systems/2.3_control_box/2.3.4_ground_computer/GroundComputer.rst @@ -0,0 +1,21 @@ +Ground Computer +================ + +The Ground Computer runs the [Data Processing program][data-processing-repo] and may run the [State Visualization program][state-visualization-repo] as well. + +Inputs +-------- +- +- +- + +Outputs +--------- +- +- +- + +Block Properties +----------------- +- Runs AltOS for configuring the commercial avionics +- Raspberry Pi or old laptop diff --git a/docs/project_structure/2.0_ground_systems/2.3_control_box/ControlBox.rst b/docs/project_structure/2.0_ground_systems/2.3_control_box/ControlBox.rst new file mode 100644 index 0000000..1791c90 --- /dev/null +++ b/docs/project_structure/2.0_ground_systems/2.3_control_box/ControlBox.rst @@ -0,0 +1,13 @@ +Control Box +============ +Control Box refers to the enclosure with the big red button that launches the rocket. + +.. toctree:: + :maxdepth: 3 + + 3.3.1_physical_interface/README + 3.3.2_ground_telemetry/README + 3.3.3_ground_computer/README + 3.3.4_local_network/README + 3.3.5_gui_server/README + 3.3.6_gui_client/README diff --git a/docs/project_structure/4.0_ground_station/GroundStation.rst b/docs/project_structure/2.0_ground_systems/GroundSystems.rst similarity index 51% rename from docs/project_structure/4.0_ground_station/GroundStation.rst rename to docs/project_structure/2.0_ground_systems/GroundSystems.rst index 149220b..f26d658 100644 --- a/docs/project_structure/4.0_ground_station/GroundStation.rst +++ b/docs/project_structure/2.0_ground_systems/GroundSystems.rst @@ -5,8 +5,6 @@ The Ground Station is the Ground Computer plus all the supporting software & har .. toctree:: :maxdepth: 3 - 4.1_transceiver/Transceiver - 4.2_ground_computer/GroundComputer - 4.3_wifi_router/WiFiRouter - 4.4_gui_server/GUI_Server - 4.5_gui_client/GUI_Client + 3.1_launch_comms/README + 3.2_launch_box/README + 3.3_control_box/README diff --git a/docs/project_structure/3.0_launch_system/3.1_launch_box/LaunchBox.md b/docs/project_structure/3.0_launch_system/3.1_launch_box/LaunchBox.md deleted file mode 100644 index 896f964..0000000 --- a/docs/project_structure/3.0_launch_system/3.1_launch_box/LaunchBox.md +++ /dev/null @@ -1,17 +0,0 @@ -Launch Box -=========== - -The Launch Box ignites the booster when launch signal received from Control Box. - -Inputs --------- -- Power Systems -- Control Box - - 8-bit Launch Signal - -Outputs ---------- -- Booster E-Match (External) - -Block Properties ---------------------------- diff --git a/docs/project_structure/3.0_launch_system/3.2_control_box/ControlBox.md b/docs/project_structure/3.0_launch_system/3.2_control_box/ControlBox.md deleted file mode 100644 index 68d8c08..0000000 --- a/docs/project_structure/3.0_launch_system/3.2_control_box/ControlBox.md +++ /dev/null @@ -1,15 +0,0 @@ -Control Box -============= - -The Control Box is the enclosure with the big red button. - -Inputs --------- -- - -Outputs ---------- -- - -Block Properties ---------------------------- diff --git a/docs/project_structure/3.0_launch_system/LaunchSystem.rst b/docs/project_structure/3.0_launch_system/LaunchSystem.rst deleted file mode 100644 index 4a4976d..0000000 --- a/docs/project_structure/3.0_launch_system/LaunchSystem.rst +++ /dev/null @@ -1,9 +0,0 @@ -Launch System ---------------- -The launch system is the system that launches the rocket. We are temporarily using the OSU AIAA wireless ignition system until we have one built and tested for OSU HART. - -.. toctree:: - :maxdepth: 3 - - 3.1_launch_box/LaunchBox - 3.2_control_box/ControlBox diff --git a/docs/project_structure/4.0_ground_station/4.1_transceiver/Transceiver.md b/docs/project_structure/4.0_ground_station/4.1_transceiver/Transceiver.md deleted file mode 100644 index 728c5f1..0000000 --- a/docs/project_structure/4.0_ground_station/4.1_transceiver/Transceiver.md +++ /dev/null @@ -1,19 +0,0 @@ -Transceiver -============ - -The Transceiver communicates with the Avionics and relays the telemetry back to the Ground Computer. - -Inputs --------- -- Avionics Telemetry - -Outputs ---------- -- Ground Computer - - Serial connection - -Block Properties ---------------------------- -- Antennas -- Coaxial Cable -- TeleDongle diff --git a/docs/project_structure/4.0_ground_station/4.2_ground_computer/GroundComputer.md b/docs/project_structure/4.0_ground_station/4.2_ground_computer/GroundComputer.md deleted file mode 100644 index 19c45a3..0000000 --- a/docs/project_structure/4.0_ground_station/4.2_ground_computer/GroundComputer.md +++ /dev/null @@ -1,19 +0,0 @@ -Ground Computer -================ - -The Ground Computer runs the GUI Server and may run the GUI Client as well. - -Inputs --------- -- Power Systems -- Transceiver -- User (External) - -Outputs ---------- -- Environment (External) - -Block Properties ------------------ -- Runs AltOS for configuring the commercial avionics -- Raspberry Pi diff --git a/docs/project_structure/4.0_ground_station/4.3_wifi_router/WiFiRouter.md b/docs/project_structure/4.0_ground_station/4.3_wifi_router/WiFiRouter.md deleted file mode 100644 index 628198b..0000000 --- a/docs/project_structure/4.0_ground_station/4.3_wifi_router/WiFiRouter.md +++ /dev/null @@ -1,15 +0,0 @@ -WiFi Router -============== - -The WiFi Router serves as the access point for the WLAN. - -Inputs --------- -- - -Outputs ---------- -- - -Block Properties ---------------------------- diff --git a/docs/project_structure/4.0_ground_station/4.4_gui_server/GUI_Server.md b/docs/project_structure/4.0_ground_station/4.4_gui_server/GUI_Server.md deleted file mode 100644 index b83f487..0000000 --- a/docs/project_structure/4.0_ground_station/4.4_gui_server/GUI_Server.md +++ /dev/null @@ -1,15 +0,0 @@ -GUI Server -=========== - -The Ground Server saves telemetry for later use, processes the telemetry, and serves the processed data to the GUI Client. - -Inputs --------- -- - -Outputs ---------- -- - -Block Properties ---------------------------- diff --git a/docs/project_structure/ProjectStructure.rst b/docs/project_structure/ProjectStructure.rst new file mode 100644 index 0000000..2ab07fb --- /dev/null +++ b/docs/project_structure/ProjectStructure.rst @@ -0,0 +1,9 @@ +System Structure +================== + +.. toctree:: + :maxdepth: 3 + + 1.0_avionics/Avionics + 2.0_ground_systems/GroundSystems + diff --git a/docs/project_structure/Structure.rst b/docs/project_structure/Structure.rst deleted file mode 100644 index 8d34d3b..0000000 --- a/docs/project_structure/Structure.rst +++ /dev/null @@ -1,10 +0,0 @@ -System Structure -================== - -.. toctree:: - :maxdepth: 3 - - 1.0_power_systems/PowerSystems - 2.0_avionics/Avionics - 3.0_launch_system/LaunchSystem - 4.0_ground_station/GroundStation