Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article will help you get setup if you have a M1 with a solution using Docker Desktop.

\uD83D\uDCD8 Instructions for Docker Setup

Info

This guide will provide instructions for getting a virtual environment setup with Docker which will allow you to simulate your code in a Linux environment

  1. Download Docker Desktop for Apple Silicon (https://www.docker.com/products/docker-desktop/ )

  2. Install the latest version of vagrant (https://www.vagrantup.com/downloads )

    1. For M1s, you can use brew or you can download the ARM64 version

  3. Clone the repo: git clone https://github.com/uw-midsun/box.git

  4. Go to your box directory and switch to master branch

    1. You can check if you are on the master branch if you run git branch

      Code Block
      ~ % cd box 
      box % git checkout master
  5. Before running vagrant up , make sure that you have docker open

  6. Run vagrant up --provider=docker

  7. Run vagrant ssh

  8. Run cd shared

  9. Run git clone https://github.com/uw-midsun/fwxv.git && cd fwxv (if you clone with https, you will need to set up an ssh key later which is covered in our setup page)

  10. Run scons sim --project=leds --platform=x86 to test that your environment is working correctly. If it compiles and runs your environment is set up. Correct output will be constant printing of “blink.” To stop the output, just click ctr + c.

👾 Guide to flashing on M1s

Note

Only follow these instructions if you have already finished the instructions below and are ready to flash

...

  1. Ensure you are not in the linux environment (Docker environment)

  2. Go to the box repository and start up your python virtual environment by running source venv/bin/activate

  3. Try running arm-none-eabi-gcc --version and look for output. If it says that it cannot find arm-none-eabi-gcc then run source ~/.zshrc

    1. If it still doesn’t work, please contact a lead for help

  4. Make the necessary connections you need with the hardware

  5. cd shared/fwxv then run scons flash --project=[project name] (If you need some other scons command please reference the build_system.md file)

✨ Guide to setting up dependencies for flashing on M1s

Note

Ensure that these steps, including any future flashing activities, are performed outside the Linux/Docker environment

...