How to setup your environment?

This page will focus on ensuring users have the necessary tools and resources to get started with the project.

Prerequisites

1. STM32CubeIDE (v1.16.1 or later)

   • Download here
   • STM32CubeIDE is required to build and develop the firmware for the motor controller project.

2. STM32CubeMX (Optional, for further microcontroller configuration)

   • Download here
   • STM32CubeMX allows for easy configuration of peripherals on the STM32 MCU.

3. STM32 Motor Control SDK (MCSDK) (For future driver generation)

   • Download here
   • The MCSDK will be required once the project transitions towards driver generation.

Additional Tools

• Git (For version control)

  • Download Git
  • Ensure Git is installed to clone the repository and manage code contributions.

• SSH Key Setup

  • Follow the steps to set up SSH authentication for secure Git operations: GitHub SSH Setup.

Setting Up SSH Authentication

1. Generate SSH Key:

   ssh-keygen -t ed25519 -C "your_email@example.com"

2. Add the SSH Key to the Agent:

   eval "$(ssh-agent -s)"
   ssh-add ~/.ssh/id_ed25519

3. Add the SSH Key to GitHub by copying the public key and adding it to your account.

Project Setup Instructions

1. Clone the Repository:

   • Ensure SSH is set up correctly:

     git clone git@github.com:MSU-Solar/motor_controller_schip.git

2. Set Up STM32CubeIDE:

   • Install the IDE, and open the project by navigating to:

     motor_controller/motor_controller/STM32CubeIDE/.cproject