S3 Flight Software

How to install the Arduino IDE on Windows

0. Download Arduino IDE from here
1. TBD - need to add "how to download + run arduino IDE" detail for Windows Version
2. If on Windows, you will need to install a driver to connect to the board:
   • Open this link in a browser
   • Click "adafruit_drivers_X.X.X.X.exe" to download it
   • Double-click "adafruit_drivers_X.X.X.X.exe"
   • Click "I Agree", "Next", "Close" to get the driver installed

How to install the Arduino IDE on Linux

0. Download Arduino IDE from here

1. Choose "Linux AppImage 64 bits (X86-64)"

2. The file "arduino-ide_2.1.1_Linux_64bit.AppImage" will be saved to your Downloads folder

3. Run these commands in a terminal

    cd ~/Downloads/
    chmod +x arduino-ide_*
    ./arduino-ide_*
   

4. The Arduino IDE should open

5. Click "File->Preferences"

6. Paste the following into the "Additional Board URLs" textbox:

    https://adafruit.github.io/arduino-board-index/package_adafruit_index.json
   

7. Click "Ok" to close the Preferences window

8. Click "Tools -> Board -> Boards Manager"

9. Search for "Arduino SAMD Boards" and click "Install"

10. Wait a few minutes for the installation to complete

11. Next, search for "Adafruit SAMD Boards" and click "Install"

12. Wait a few minutes for the installation to complete

13. Reopen the Arduino IDE

    • Click "File -> Quit"

    • Run these commands in a terminal

      cd ~/Downloads/
      chmod +x arduino-ide_*
      ./arduino-ide_*
      

14. Select "Tools -> Board -> Adafruit SAMD boards -> Adafruit ItsyBitsy M4 (SAMD51)"

15. Done with setup! Continue to a different section.

How to get the latest Quest software on Linux

0. Go to the Flight SW repository release page (link)

1. Download the latest "Source code (zip)"

2. Unzip the folder

    cd ~/Downloads
    unzip 0.0.1.zip
   

3. Inside, you will find a "libraries" folder

4. Copy the "libraries" folder

5. Navigate to "~/Arduino/", delete the "libraries" folder if it exists, and paste the copied "libraries" folder

    rm -r ~/Arduino/libraries
    mkdir -p ~/Arduino/libraries
    cp -r ~/Downloads/0.0.1/libraries ~/Arduino
   

6. If you are updating a previously-installed version, you are done. Try building your project's flying.ino file in the Arduino IDE.

7. If this is your first time downloading the software, follow these steps to get the template flying.ino:

8. Make a folder somewhere on your PC to hold your project files. In this example, we will use ~/Projects/My_Experiment

9. Make the folder using a file explorer window, or run this command:

    mkdir -p ~/Projects/My_Experiment
   

10. Copy flying.ino and flying.h into your project folder

     cp ~/Downloads/0.0.1/flying.ino ~/Downloads/0.0.1/flying.h ~/Projects/My_Experiment/
    

11. Open the Arduino IDE (If you have not installed it yet, see the section for Windows or Linux) first

12. In the Arduino IDE, select "File -> Open"

13. Navigate to ~/Projects/My_Experiment/ and double-click flying.ino

14. Click "Sketch -> Verify/Compile"

15. Wait a few seconds - the compilation should complete and output a message "Sketch uses XXX bytes of program..."

16. Move to the next section

Connect to a development board

0. Open the Arduino IDE (If you have not installed it yet, see the section for Windows or Linux) first

1. In the Arduino IDE, select "File -> Open"

2. Navigate to ~/Projects/My_Experiment/ and double-click flying.ino

3. Connect a development board to your PC using a USB cable

4. Click "Tools -> Port -> /dev/ttyACM0 (Adafruit ItsyBitsy M4 (SAMD51))"

5. Click Tools -> Serial Monitor

6. To the right of the "Message" text box, there is a dropdown menu. If it says "New Line", select "Carrage Return" instead.

7. Click "Sketch -> Upload" (or press Ctrl+U)

8. Wait a few seconds for the code to compile and upload.

9. If all goes well, the serial monitor should output something similar to the following:

    Verify successful
    System Boot Version XX
    Compiled Date => XX
    Source file => XX
   
    Free Memory = XX HEX or XX DEC
    Input 'T' to enter test within 15 seconds
   

10. You can now type a T and hit <Enter> to start test mode. If you don't hit T fast enough, hit the RESET button on the development board to reboot and output the prompt again.

Write your own code for your experiment

0. Open the Arduino IDE (If you have not installed it yet, see the section for Windows or Linux) first
1. In the Arduino IDE, select "File -> Open"
2. Navigate to ~/Projects/My_Experiment/ and double-click flying.ino
3. Edit the Flying() function in flying.ino with your experiment's custom code
4. Click "Sketch -> Upload" (or press Ctrl+U)
5. Your custom code will run