Hello and welcome to SOAR's Payload EECS repository.
Please feel free to take on any issue on the issues tab.
If you want to contribute first Download Github Desktop and set it up to your github account.
After that there are currently 2 approaches for contributions:
-
Forking our repo: This is the easiest way to get started, no permissions required. Watch this video
-
Creating a branch as a member: This way requires you to be added to one of our teams, so if you're not sure aobut staying long term I'd suggest starting with forking, but if you're commited to helping us out here is what you can do:
- Ask one of the leads to add you to a team as a contributor
- Accept the team invitation in your email
- Follow this video on how to make contributions as a team member
Either approach you take, you're gaining some valuable git
skills, furthermore you can make as much mistakes as needed, it's part of learning! And you won't have to fear "breaking something important".
- Any issue with the label
Good First Issue
is probably an easy issue to start with and it might have a guided solution to follow - Some issues may say Blocked by and then list another issue, this just means you most likely need to solve that other issue first or wait for someone else to solve it before proceeding
- Issues should be labeled with the programming language required so you can pick and choose what you're most comfortable
We are constantly making changes to our repo so don't worry if you ever feel behind, that's usual. To keep up to date your code, perform the following:
- If you're not on a fork, checkout to the branch
main
and pull the latest changes. Then checkout back to your branch. - On Github Desktop click on
Branch > Rebase Current Branch
- If you're on a fork select
upstream/main
, else selectmain
- Proceed with the rebase and hopefully by the end of it you should see on the push button the word
force push
- Force push your changes to your branch
- IF rebasing doesn't work then attempt to merge to either
upstream/main
if on fork or justmain
if not on fork
Merging creates a messier git commit history but there are times it's the only option
- Follow the guide here under software preparation.
- After, open the Arduino IDE and select the board
XIAO_ESP32S3
. - Click on the libraries button:
- Install the following libraries (along any dependencies if they ask for it):
Adafruit BMP3XX
by AdafruitAdafruit GPS
by AdafruitAdafruit Unified Sensor
by AdafruitAdafruit BusIO
by AdafruitAsync ElegantOTA
by Ayush SharmaAsync TCP
by dvarrelESP Async Webserver
by Me-No-DevESP32Servo
by Kevin Harrington, John K. BennetESPAsyncTCP
by dvarrelESPAsyncWebServ
by dvarrel
- Click on the complie button
- IF Successful you are done. ELSE try installing the libraries it might suggest to install.
NOTE: Don't install any
BLE
orBluetooth
libraries that is already installed when you included theXIAO_ESP32S3
board
For flowcharts and general charts we make, we use Draw.io, so just go there and import the drawio files.