From a03ded8dcc241b56ad782b6885f7741ced4c6d47 Mon Sep 17 00:00:00 2001 From: Chris Gerth Date: Fri, 22 Nov 2024 06:59:01 -0600 Subject: [PATCH] wip docs --- docs/autoSequencer.md | 6 ++++++ docs/closedLoopDrivetrainControl.md | 0 docs/drivetrain.md | 23 +++++++++++++++++++++++ docs/drivetrainControlStrategy.md | 16 ++++++++++++++++ docs/localization.md | 0 docs/navigation.md | 0 docs/utilites.md | 20 ++++++++++++++++++++ docs/vsCodeDeployment.md | 15 +++++++++++++++ 8 files changed, 80 insertions(+) create mode 100644 docs/autoSequencer.md create mode 100644 docs/closedLoopDrivetrainControl.md create mode 100644 docs/drivetrain.md create mode 100644 docs/drivetrainControlStrategy.md create mode 100644 docs/localization.md create mode 100644 docs/navigation.md create mode 100644 docs/utilites.md create mode 100644 docs/vsCodeDeployment.md diff --git a/docs/autoSequencer.md b/docs/autoSequencer.md new file mode 100644 index 0000000..cd1baa0 --- /dev/null +++ b/docs/autoSequencer.md @@ -0,0 +1,6 @@ +# Auto Sequencer + +## Overall Design Ideas + +## Code Implementation + diff --git a/docs/closedLoopDrivetrainControl.md b/docs/closedLoopDrivetrainControl.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/drivetrain.md b/docs/drivetrain.md new file mode 100644 index 0000000..f6f0e80 --- /dev/null +++ b/docs/drivetrain.md @@ -0,0 +1,23 @@ +# Drivetrain Control + +## Swerve Drive Overview + +## Overall Drivetrain Control + +xvel yvel rotational velocity commands + +kinematics to module commands + +## Module Control + +PID + FF on wheel + +PID on angle + +## Constants & Configuration + +wheel ratios + +effective rolling radius + + diff --git a/docs/drivetrainControlStrategy.md b/docs/drivetrainControlStrategy.md new file mode 100644 index 0000000..6e825a4 --- /dev/null +++ b/docs/drivetrainControlStrategy.md @@ -0,0 +1,16 @@ +# Picking a Drivtrain Control Strategy + +## Arbitration + +pass off drivetrain command from unit to unit + +### Manual Control + +### Autonomous Path Following + +### Teleop Navigation + +### TODO - Others + +drive toward gamepiece + diff --git a/docs/localization.md b/docs/localization.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/navigation.md b/docs/navigation.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/utilites.md b/docs/utilites.md new file mode 100644 index 0000000..d4b6f9d --- /dev/null +++ b/docs/utilites.md @@ -0,0 +1,20 @@ +# Utilities + +## Alliance Transform + +## Calibration + +## Crash Logging + +## External Drive Management + +## Faults + +## Map Lookup 2D + +## Power & RIO Monitors + +## Segment Time Tracker + +## Singleton Infrastructure + diff --git a/docs/vsCodeDeployment.md b/docs/vsCodeDeployment.md new file mode 100644 index 0000000..8e17732 --- /dev/null +++ b/docs/vsCodeDeployment.md @@ -0,0 +1,15 @@ +# vsCode Project Setup + +## Setup + +what file + +what extensions + +## What is Supported + +### Basic Deployment + +### Simulation + +### Debugging on RoboRIO