Skip to content

usfsoar/NSL_23-24_PayloadEECS

Repository files navigation

NSL_23-24_PayloadEECS 🚀

GitHub top language GitHub contributors GitHub issues

Raspberry Pi Arduino

Payload BAnner Image

For new members

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:

  1. Forking our repo: This is the easiest way to get started, no permissions required. Watch this video

  2. 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:

  1. Ask one of the leads to add you to a team as a contributor
  2. Accept the team invitation in your email
  3. 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".

Some tips on picking up Issues

  • 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

Keeping up to date your branch/fork

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:

  1. If you're not on a fork, checkout to the branch main and pull the latest changes. Then checkout back to your branch.
  2. On Github Desktop click on Branch > Rebase Current Branch
  3. If you're on a fork select upstream/main, else select main
  4. Proceed with the rebase and hopefully by the end of it you should see on the push button the word force push
  5. Force push your changes to your branch
  6. IF rebasing doesn't work then attempt to merge to either upstream/main if on fork or just main if not on fork

Merging creates a messier git commit history but there are times it's the only option

Compilling for the ESP32S3

  1. Follow the guide here under software preparation.
  2. After, open the Arduino IDE and select the board XIAO_ESP32S3.
  3. Click on the libraries button:
  1. Install the following libraries (along any dependencies if they ask for it):
    • Adafruit BMP3XX by Adafruit
    • Adafruit GPS by Adafruit
    • Adafruit Unified Sensor by Adafruit
    • Adafruit BusIO by Adafruit
    • Async ElegantOTA by Ayush Sharma
    • Async TCP by dvarrel
    • ESP Async Webserver by Me-No-Dev
    • ESP32Servo by Kevin Harrington, John K. Bennet
    • ESPAsyncTCP by dvarrel
    • ESPAsyncWebServ by dvarrel
  2. Click on the complie button
  3. IF Successful you are done. ELSE try installing the libraries it might suggest to install.

NOTE: Don't install any BLE or Bluetooth libraries that is already installed when you included the XIAO_ESP32S3 board

Resources

Viewing charts

For flowcharts and general charts we make, we use Draw.io, so just go there and import the drawio files.

About

Repository for EE/CS section of the payload for NSL 23-24

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published