Sliders_McGee/README.md

# Sliders_McGee

Software for the Sliders McGee project

## Header Pinout

![Board header description](readme_assets/Slides_McGee_Pinout.png)

## Bootloading Procedure

Setup: 
- Board unpowered and USB cable unplugged
- Wire jumper between 3.3V header and pin 8 of input header (BL pin)

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 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.