Environment Setup

Set up Environment (Script)

The following script was created to streamline the process of installing all of the required dependencies for a Windows EVT environment. To get started, paste the following command into Powershell.

irm "https://raw.githubusercontent.com/RIT-EVT/Setup-Script/main/setup_windows.ps1" | iex

The script will automatically install CMake, the ARM Toolchain, and clang-format. It WILL NOT register the arm tools into your path since many users choose to install GCC_ARM_TOOLS_PATH in every project individually.

Setting Up SSH

1. 1. Set Up SSH Keys 

      1. If you need to set up git ssh-keys, follow the steps here Github SSH Key Tutorial

      2. if you have multiple ssh keys, instead use

         1. git clone git@github.com:RIT-EVT/EVT-core.git --config core.sshCommand="ssh -i ~/location/to/private_ssh_key"

      3. If this is not set up correctly, you will get an error later on when trying to clone repositories suggesting you check you have the correct permissions

Clone Repository

• EVT-core repo can be found at the following link: https://github.com/RIT-EVT/EVT-core

1. Clone repo

   1. Navigate to directory to put 'EVT-core' folder in, for example EVT/

   2. git clone git@github.com:RIT-EVT/EVT-core.git

2. Update submodules

   1. git submodule update --init --recursive

   2. This will need to be done every time a new repository is cloned

3. The code can be edited using your preferred text editor.  Recommendations are shown below

   1. Clion - Fully Fledged IDE for C/C++ development.  Student License provided by RIT.  See 'Utilizing Clion IDE section'

   2. Visual Studio Code - Lightweight editor that provides lots of useful functionality and suffices in most cases.

Setting Up Clion

• Fully Fledged IDE for C/C++ development.  Provides the following useful features

  • Syntax highlighted and easy code navigation

  • GUI Interface for OpenOCD build tools that provide 1 click code building and board programming

  • GUI Interface for GDB Debugger for debugging code with breakpoints and memory view

    • Optional view of direct peripheral registers.

1. Set up an account on https://www.jetbrains.com/

   1. Use RIT email and apply for educational license

2. Download and install IDE

   1. Download from https://www.jetbrains.com/clion/download/#section=windows

   2. Follow installer instructions

3. Launch Clion from Start Menu

   1. Complete steps necessary to register IDE

4. Open EVT-core project

   1. Cloning the Repository

      1. Using CLion's GitHub Integration 

         1. If you haven't already, make sure you have a GitHub account with access to the EVT-core repository (more detail)

         2. Select Get from VCS

         3. Select GitHub from the righthand side

         4. Log in to GitHub following the prompts on the JetBrains website

         5. Select RIT-EVT/EVT-core from the list of repositories

         6. Select Clone in the bottom right corner

         7. If you have any errors with this process you may need to use Git Bash instead

      2. Using a shell (like Git Bash)

         1. Navigate to directory you wish to clone EVT-core into

         2. Clone Repo

            1. Right click in windows file manager and select 'Git Bash Here'

            2. Type in command git clone git@github.com:RIT-EVT/EVT-core.git

               1. If you have issues with git integration within Clion see:

                  1. https://stackoverflow.com/questions/38105563/intellij-idea-git-permission-denied-publickey

5. Fill out the Project Wizard

   1. Toolchain

      1. You should just use the default MinGW settings

      2. If you don't have MinGW installed, select "Download..." and follow the provided steps

      3. Click Next

   2. CMake

      1. Edit build directory to 'build'

      2. Edit build options to '-j'

      3. Set environment to GCC_ARM_TOOLS_PATH=<your_path_to_gcc_arm>\bin

         1. Replace '\' with '/'

   3. Click OK

      1. Don't worry about making mistakes here. These can be edited later in File → Settings → Build, Execution, Deployment → CMake

6. Set up Clang Tools

   1. Confirm that Clang Tools is working by selecting File → Reload CMake Project.

   2. Lastly, go to File → Settings → Editor → Code Style, and make sure "Enable ClangFormat" is checked.

Setting Up VS Code

• Light Weight Fully Fledged IDE for C/C++ development.  Provides the following useful features

  • Syntax highlighted and easy code navigation

  • Helpful customizations to enable high efficiency coding

  • GUI Interface for GDB Debugger for debugging code with breakpoints and memory view

1. Download VS Code: https://code.visualstudio.com/download

2. Download necessary VS Code extensions

   1. On the left hand side of the VS Code window, there is an extensions tab. Click on this tab and search for and install the following extensions:

      1. C/C++ Extension Pack

      2. Github Repositories

      3. Github Pull Requests and Issues

      4. Clang-Format

3. Set up a Github account if you do not already have one: https://github.com/join

4. Use this tutorial to setup/authorize your github account in vscode: https://docs.microsoft.com/en-us/learn/modules/introduction-to-github-visual-studio-code/

5. See the current firmware lead to get access to EVT-Core github repository

6. Make a local folder on your laptop that can serve as your vscode workspace for EVT-Core

   1. make sure this folder is not automatically backed up by any cloud storage service like Google Drive or OneDrive!

Setting Up the Environment (Manual Setup)

1. Install Cmake

   1. Download Windows installer from: https://cmake.org/download/

   2. Choose Add to path option (can choose current user or all users)

2. Install GNU ARM Tools Path

   1. Download the installer for v12.3 from https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads

      1. Should have a name similar to "arm-gnu-toolchain-12.3.rel1-mingw-w64-i686-arm-none-eabi.exe"

   2. To avoid problems later on, make sure the path to the toolchain has no spaces

      1. You will have to manually modify the automatically generated path because it has spaces in it

      2. Ex: C:\Program_Files_No_Spaces\Arm_GNU_Toolchain_arm-none-eabi\12.3_rel1

   3. Take note of the install location and save for later.

3. Install Git for Windows

   1. Download Installer from https://git-scm.com/download/win

4. Download the LLVM Windows installer from https://releases.llvm.org

   1. Make sure the version is 15.0.7

   2. The installer should be titled something like "LLVM-x.x.x-win64.exe"

   3. Run the installer, making sure to select the option to add LLVM to the system PATH

   4. Clang tools will not start working until after a restart.

5. Restart your PC

  Set up Environment (Script)

The following script was created to streamline the process of installing all of the required dependencies for a macOS EVT environment. Just simply paste these commands all at once (or one by one) into your Terminal.

curl https://raw.githubusercontent.com/RIT-EVT/Setup-Script/main/setup_mac.sh | sh

The script will automatically install Homebrew, CMake, the ARM Toolchain, and clang-format. It will also automatically register PATH variable GCC_ARM_TOOLS_PATH to the correct value for your system and architecture. 

Setting Up SSH

1. 1. Set Up SSH Keys 

      1. If you need to set up git ssh-keys, follow the steps here Github SSH Key Tutorial

      2. if you have multiple ssh keys, instead use

         1. git clone git@github.com:RIT-EVT/EVT-core.git --config core.sshCommand="ssh -i ~/location/to/private_ssh_key"

      3. If this is not set up correctly, you will get an error later on when trying to clone repositories suggesting you check you have the correct permissions

Clone Repository

• EVT-core repo can be found at the following link: https://github.com/RIT-EVT/EVT-core

1. Clone repo

   1. Navigate to directory to put 'EVT-core' folder in, for example ~/EVT/

   2. git clone git@github.com:RIT-EVT/EVT-core.git

2. Update submodules

   1. git submodule update --init --recursive

   2. This will need to be done every time a new repository is cloned

3. The code can be edited using your preferred text editor.  Recommendations are shown below

   1. Clion - Fully Fledged IDE for C/C++ development.  Student License provided by RIT.  See 'Utilizing Clion IDE section'

   2. Visual Studio Code - Lightweight editor that provides lots of useful functionality and suffices in most cases.

Utilizing Clion IDE

• Fully Fledged IDE for C/C++ development.  Provides the following useful features:

  • Syntax highlighted and easy code navigation

  • GUI Interface for OpenOCD build tools that provide 1 click code building and board programming

  • GUI Interface for GDB Debugger for debugging code with breakpoints and memory view

    • Optional view of direct peripheral registers.

1. Set up an account on https://www.jetbrains.com/

   1. Use RIT email and apply for educational license

2. Download and install IDE

   1. Put the following int a terminal: brew install --cask clion

3. Launch Clion from application manager

   1. Complete steps necessary to register IDE

4. Open EVT-core project

   1. Select Open (May be File→Open).

   2. Select EVT-core folder to open

5. While opening it will ask you to configure CMake settings.  These can be edited later in File → Settings → Build, Execution, Deployment → CMake

   1. edit build directory to 'build'

   2. edit build options to '-j'

6. Edit the code as desired within IDE

Set up Environment (Manual)

• This is a manual installation of all of the components that the automatic script installs. If you wish to install everything manually you can follow these steps!

1. Go to https://brew.sh and install the homebrew package manager.

2. Tap the required repository to retreive the arm-gnu-toolchain v12.3

   1. brew tap actuallytaylor/formulae

3. Install the arm-gnu-toolchain

   1. brew install arm-gnu-toolchain@12

4. Set GCC_ARM_TOOLS_PATH environment variable

   1.  Add export GCC_ARM_TOOLS_PATH="$HOMEBREW_PREFIX/bin/" to your ~/.zshrc if you have ZSH or ~/.bash_profile if you have bash.

      1. To see what shell you are using you can use the command echo $SHELL

   2. Run source ~/.zshrc if you have ZSH or source ~/.bash_profile if you have bash.

5. Install Cmake

   1. brew install --cask cmake

   2. Add export PATH=$PATH:/Applications/CMake.app/Contents/bin to your ~/.zshrc if you have ZSH or ~/.bash_profile if you have bash.

6. Install clang-format

   1. brew install clang-format

  Set up Environment (Script)

The following script was created to streamline the process of installing all of the required dependencies for a Linux EVT environment. To get started, paste the following script into a Linux terminal.

curl https://raw.githubusercontent.com/RIT-EVT/Setup-Script/main/setup_linux.sh | sh

The script will automatically install CMake, the ARM Toolchain, and clang-format. 

Setting Up SSH

1. 1. Set Up SSH Keys 

      1. If you need to set up git ssh-keys, follow the steps here Github SSH Key Tutorial

      2. if you have multiple ssh keys, instead use

         1. git clone git@github.com:RIT-EVT/EVT-core.git --config core.sshCommand="ssh -i ~/location/to/private_ssh_key"

      3. If this is not set up correctly, you will get an error later on when trying to clone repositories suggesting you check you have the correct permissions

Clone Repository

• EVT-core repo can be found at the following link: https://github.com/RIT-EVT/EVT-core

1. Clone repo

   1. Navigate to directory to put 'EVT-core' folder in, for example ~/repos 

   2. git clone git@github.com:RIT-EVT/EVT-core.git

2. Update submodules

   1. git submodule update --init --recursive

   2. This will need to be done every time a new repository is cloned

3. The code can be edited using your preferred text editor.  Recommendations are shown below

   1. Visual Studio Code - Lightweight editor that provides lots of useful functionality and suffices in most cases.

   2. Clion - Fully Fledged IDE for C/C++ development.  Student License provided by RIT.  See 'Utilizing Clion IDE section'

Utilizing Clion IDE

• Fully Fledged IDE for C/C++ development.  Provides the following useful features:

  • Syntax highlighted and easy code navigation

  • GUI Interface for OpenOCD build tools that provide 1 click code building and board programming

  • GUI Interface for GDB Debugger for debugging code with breakpoints and memory view

    • Optional view of direct peripheral registers.

1. Set up an account on https://www.jetbrains.com/

   1. Use RIT email and apply for educational license

2. Download and install IDE

   1. sudo snap install clion --classic

3. Launch Clion from application manager

   1. Complete steps necessary to register IDE

4. Open EVT-core project

   1. Select Open (May be File→Open).

   2. Select EVT-core folder to open

5. While opening it will ask you to configure CMake settings.  These can be edited later in File → Settings → Build, Execution, Deployment → CMake

   1. Edit build directory to 'build'

   2. Edit build options to '-j'

   3. Set environment to GCC_ARM_TOOLS_PATH=<your_path_to_gcc_arm>/bin

   4. Click OK

6. Edit the code as desired within IDE

Set up Environment (Manual)

• Procedure written for a Debian Ubuntu environment, but the procedure can be easily adapted for any linux distro

1. Install GNU ARM Embedded Toolchain

   1. Download  'arm-gnu-toolchain-12.3.rel1-x86_64-arm-none-eabi.tar.xz' from https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads

      1. On MacOS, you will want 'arm-gnu-toolchain-12.3.rel1-darwin-x86_64-arm-none-eabi.tar.xz'

   2. Extract code to desired directory.

      1. tar -xvf <gcc-arm-tar.bz2> -C <desired compiler location>

      2. The compiler location should be somewhere permanent

   3. Set GCC_ARM_TOOLS_PATH environment variable

      2. 1. Edit ~/.bashrc  or ~/.zshrc  depending on your shell and append the following line:

            1. export GCC_ARM_TOOLS_PATH=<your_path_to_gcc_arm>/bin

            2. On fish, it's ~/.config/fish/config.fish

               1. set -gx GCC_ARM_TOOLS_PATH <your_path_to_gcc_arm>/bin

         2. On MacOS there are two possible locations you may need to put the line above. Execute the command below to determine where to place the line:

            1. echo "$SHELL"

         3. If you got /bin/zsh  then add the export to ~/.zshrc, if you have /bin/bash then add the export to ~/.bash_profile.

   4. Update environment

      1. Easiest way is to restart your shell (close & open the terminal window)

      2. source ~/.bashrc  or ~/.zshrc  or ~/.config/fish/config.fish 

      3. On MacOS source ~/.zshrc  if you have ZSH or ~/.bash_profile  if you have bash

2. Install cmake

   1. Ubuntu / Debian: sudo apt-get install cmake 

   2. Arch: sudo pacman -S cmake 

   3. On MacOS install CMake from here, then add the following line to either ~/.zsh  or ~/.bash_profile  depending on which you have and re-run the source ~/.zshrc  or source ~/.bash_profile

      1. export PATH=$PATH:/Applications/CMake.app/Contents/bin

3. Setting up Clang Format

   1. Debian / Ubuntu

      1. Run: sudo apt-get install clang-format-15 

      2. Verify your system is using the correct version: clang-format --version

      3. If not run this command to select it: sudo update-alternatives --install /usr/bin/clang-format clang-format /usr/bin/clang-format-15 100 

   2. Arch

      1. If you have an AUR helper, such as paru, you can just do <helper> -S clang-format-static-bin

      2. If not, manually install it

cd ~/Downloads
git clone https://aur.archlinux.org/clang-format-static-bin.git
cd clang-format-static-bin
makepkg -si
cd ..
rm -rf clang-format-static-bin

3. 2. 3. Put the binary in your path

         1. # first make somewhere to put it

            1. mkdir ~/bin

         2. cd ~/bin

            1. # symlink the binary
               ln -s /opt/clang-format-static/clang-format-12 clang-format

         3. Edit ~/.bashrc  or ~/.zshrc  to include it in your path with: 

            1. export PATH=$PATH:/home/<username>/bin

            2. With fish, set -gx PATH $PATH "/home/<username>/bin" 

            3. You may need a space instead of a :