From 51a5020adc3a9dc7bf8f6c1b3790d71532a0c6b1 Mon Sep 17 00:00:00 2001 From: Chris Trimble Date: Thu, 18 Jul 2024 12:09:12 -0500 Subject: [PATCH] Updated readme. --- README.md | 28 ++++++++++++++++-- .../Slides_McGee_Pinout.png | Bin 2 files changed, 25 insertions(+), 3 deletions(-) rename Slides_McGee_Pinout.png => readme_assets/Slides_McGee_Pinout.png (100%) diff --git a/README.md b/README.md index 4233b12..16177a8 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Software for the Sliders McGee project ## Header Pinout -![Board header description](Slides_McGee_Pinout.png) +![Board header description](readme_assets/Slides_McGee_Pinout.png) ## Bootloading Procedure @@ -16,5 +16,27 @@ Procedure: - Connect USB cable to board and computer - Board will present itself as a mass storage drive - Drag and drop new firmware image onto drive -- Wait, no progress will be indicated -- When bootloading is complete, board will launch application and drive will no longer be present on host computer \ No newline at end of file +- Wait aproximately 10s, no progress will be indicated +- When bootloading is complete, board will launch application and drive will no longer be present on host computer +- Removed wire jumper + +## Building This Project + +### Prerequisites + +VSCode + +STM32CubeCLT [here](https://www.st.com/en/development-tools/stm32cubeclt.html) + +VSCode STM32 Extention + +Once the prerequisites are installed, open VSCode and open the folder containing the project repo. +- On the left side, click the STM32 extention and select "Import CMake project". In the dialog box that opens, select the project root foler and acept the dialog box. +- CMake will do its CMake stuff and ask if the options are correct. The dafualts should be sufficient, click the bottom option to accept the parameters. Now you should see a build gear on the bottom toolbar with the text "Build". +- Click the build button. The newly cloned repo will buuld without error and there will be a SW.hex file in the build folder. + +## Console + +The console is used to set the maximum PWM values for each slider output and saving the values to non-volatile memory. Option selections are defined by [ ] around the expected input. Inputs not recognized are ignored. Esc is used to back out of a sub-menu without modifiying the value. + +When first connecting, press enter to display the main menu. The current values are displayed next to the slider label. \ No newline at end of file diff --git a/Slides_McGee_Pinout.png b/readme_assets/Slides_McGee_Pinout.png similarity index 100% rename from Slides_McGee_Pinout.png rename to readme_assets/Slides_McGee_Pinout.png