Home

Welcome to the Air Synth wiki!

Instructions for contributors

1. Instructions to setup the development environment can be found here.
2. Please read the coding guidelines in the Wiki before writing any code.

Setup for development

Website Link

Software prerequisites

Install the following:

On local machine

1. Code editor of your choice, although we prefer VSCode due good support for C++ and CMake through extensions.
   It also allows opening files and folders on the Raspberry Pi using. See remote SSH.
2. SSH
3. If you plan to build the project locally, also install the packages listed here.

On remote machine (Raspberry Pi)

1. Code editor of your choice, but if you want to use remote SSH, please install VSCode using the command
   sudo apt install code.
2. Packages listed here

Cloning the repository

Please ensure software prerequisites are satisfied and that these steps are followed on the Raspberry Pi.

1. Open a terminal. You can do this by SSH-ing into the Raspberry Pi.
2. Run git clone https://github.com/Rapteon/air-synth.git
3. Navigate to the checked-out directory. For example:
   cd ~/Documents/air-synth

Building the project

Follow steps 1 to 3 specified for cloning the repository if you haven't
done so yet. Then continue with the following.

1. Run the command cmake -B build. This will create the build directory for compilation.
2. Then run the command cmake --build build to build all targets.

Running the program

Follow all steps from Building the project.
Then run the program using ./build/AirSynth

The repo also has an example program to show usage. This can be executed using
./build/Printer. This will print the printer name and acceleration value obtained
from the IMU sensor.

Hardware

Connecting the Raspberry Pi in our lab

1. Connect the Raspberry Pi to a display and connect a keyboard and a mouse to it.
2. After the RPi boots up and the screen is visible, choose the
   Advanced Options -> Connect to Hidden Wireless Network option.
3. Ask the other contributors for the SSID and password for this network.
4. After connecting, you will be able to see the RPi's IP address on the common
   monitor in the lab. Search for the hostname of your device on the common monitor
   to find your IP.
5. You can then connect your development laptop to the same hidden network and use
   it to SSH into the Pi.