Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add base firmware project #23

Merged
merged 2 commits into from
Jan 24, 2023
Merged

Add base firmware project #23

merged 2 commits into from
Jan 24, 2023

Conversation

jballoffet
Copy link
Member

@jballoffet jballoffet commented Jan 22, 2023

Closes #15

Summary

This PR adds a base project for the robot firmware, using PlatformIO as framework.

Project structure

Project basic structure:

  • include: project header files
  • lib: project libraries
  • src: application source code
  • test: unit testing directory
    • test_desktop: desktop (Linux) unit tests (GoogleTest used as framework)
    • test_embedded: embedded (Arduino Uno) unit tests (Unity used as framework)

Notes

Links of interest:

Signed-off-by: Javier Balloffet javier.balloffet@ekumenlabs.com

@jballoffet
Copy link
Member Author

jballoffet commented Jan 22, 2023

Summoning @Martin-MT as a reviewer too.

Copy link
Collaborator

@francocipollone francocipollone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeahhh! Thanks for adding this! 🚀

Would it be convenient to add a "how to start" section for using platform io with this project or the links in platform io are pretty well guided? I haven't tried it locally yet.

@jballoffet
Copy link
Member Author

Yeahhh! Thanks for adding this! rocket

Would it be convenient to add a "how to start" section for using platform io with this project or the links in platform io are pretty well guided? I haven't tried it locally yet.

Good idea! I improved the README file accordingly (PlatformIO docs are pretty good though!).

Copy link
Collaborator

@francocipollone francocipollone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff! LGTM!

@Martin-MT
Copy link
Collaborator

Other than the uController being the ATmega328p (the one without the p is no longer acquirable), it LGTM.
Older versions of PlatformIO used to add more stuff to the .gitignore, but tried it myself with the newer version, and it generates something just like the one you added.

@jballoffet
Copy link
Member Author

Great, thanks @Martin-MT and @francocipollone !

@jballoffet jballoffet merged commit 5b95a30 into main Jan 24, 2023
@jballoffet jballoffet deleted the javi/setup-base-fw-project branch January 24, 2023 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Firmware] Setup base project
3 participants