Lib: Consider removing pindefs from lib and storing in the project

Open
#18 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
c
Domain
embedded-iot

Research direction

Start by locating the pindefs files, the project build directories such as app/rev2, and the main.h and driver inclusion paths. Review how HAL and CMSIS are currently stored and used across every SDR project, then discuss the impact with the listed project leads and lib maintainer. Done means an agreed dependency and pindef layout that works across the affected projects.

Written by the indexing model from the issue text.

Description

enhancement

Describe the solution you'd like
It kinda makes no sense for us to store pin defines in a common library like this. Why don't we move the pindefs files to the project build directory? (e.g. app/rev2 for the FC). This way, we can also just include the platform-specific pindef file (for the flight computer) in main.h and not have to worry about passing it to the drivers -- it's far more platform independent.

While we're here, we also might want to consider linking CMSIS as a submodule. I manually replaced the library with a newer version a few commits ago, and we might want to consider being able to pull up the HAL and CMSIS at the same time.

Scope will affect every SDR project though, so let's think all of this through.

Describe alternatives you've considered
N/A

Additional context
N/A

Points of Contact
Design discussion for: @ETSells, @NArmistead, @266-750Balloons (rev 3, rev 2, and ground station project leads)
Lib maintainer: @ETSells

Dominant language
C
Stars
0
Forks
1
Avg merge
17d 3h
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.