From 78252ae34aef02ca6739b9883bd9d7112b6b3776 Mon Sep 17 00:00:00 2001 From: judsonupchurch Date: Thu, 16 Jan 2025 20:30:43 -0600 Subject: [PATCH] Add TOC to readme --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.md b/README.md index 2b391bb..adefcf6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ +- [Purpose](#purpose) +- [Overall System Design](#overall-system-design) + * [Concept of Operation](#concept-of-operation) + * [Control Box](#control-box) + + [Logic Diagram](#logic-diagram) + + [Power Diagram](#power-diagram) + * [Actuator Box](#actuator-box) + + [Logic Diagram](#logic-diagram-1) + + [Power Diagram](#power-diagram-1) +- [Physical Design](#physical-design) + * [Control Box](#control-box-1) + + [Display PCB](#display-pcb) + - [3D Render](#3d-render) + - [PCB Design](#pcb-design) + - [Schematic](#schematic) + + [Main PCB](#main-pcb) + - [3D Render](#3d-render-1) + - [PCB Design](#pcb-design-1) + - [Schematic](#schematic-1) + + [Integrated Assembly](#integrated-assembly) + * [Actuator Box](#actuator-box-1) + + [Actuator PCB](#actuator-pcb) + - [3D Render](#3d-render-2) + - [PCB Design](#pcb-design-2) + - [Schematic](#schematic-2) + * [Full Schematic](#full-schematic) + * [Non-Latching Relay Schematic](#non-latching-relay-schematic) + * [Latching Relay Schematic](#latching-relay-schematic) + * [Igniter Relay Schematic](#igniter-relay-schematic) + + [Integrated Assembly](#integrated-assembly-1) +- [Arduino Software](#arduino-software) + * [Common Software](#common-software) + + [CAN Comms](#can-comms) + * [Control Box](#control-box-2) + + [Logic Diagram](#logic-diagram-2) + + [Custom LCD Class](#custom-lcd-class) + + [LED Groups Based on Relay Type](#led-groups-based-on-relay-type) + - [Non-Latching Relay Display](#non-latching-relay-display) + - [Latching Relay Display](#latching-relay-display) + - [Latching Solenoid Display](#latching-solenoid-display) + * [Actuator Box](#actuator-box-2) +- [System Upgrades After Initial Design](#system-upgrades-after-initial-design) + * [Servo Motor Main Valve for Throttling](#servo-motor-main-valve-for-throttling) + * [MODBUS TCP Communication for Integration in Ignition SCADA](#modbus-tcp-communication-for-integration-in-ignition-scada) + # Purpose The Texas A&M Sounding Rocketry Team designs, builds, and flies its own hybrid rocket. As part of its design cycle, static cold flows and static engine tests are performed to chacterize the engine's oxidizer tank,