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

PlatformIO library descriptor #35

Merged

Conversation

kazetsukaimiko
Copy link
Contributor

@kazetsukaimiko kazetsukaimiko commented May 14, 2024

This adds a PlatformIO library descriptor so that embedded / IoT developers can include iso-tp in their projects using PlatformIO dependency management.

What is PlatformIO?
"PlatformIO is a cross-platform, cross-architecture, multiple framework, professional tool for embedded systems engineers and for software developers who write applications for embedded products."

It can be referenced in platformio.ini either by repo url:

[env]
platform = espressif32
framework = arduino
lib_deps = 
	https://github.com/SimonCahill/isotp-c.git#v1.1.2

Or you can publish the library to the PlatformIO Registry and reference it by name / version:

[env]
platform = espressif32
framework = arduino
lib_deps = 
	SimonCahill/isotp-c @ v1.1.2

See the Dependencies page for best practices.

Tested on my fork using a branch name reference:

[env]
platform = espressif32
framework = arduino
lib_deps = 
	https://github.com/kazetsukaimiko/isotp-c.git#platformio-library-registration

@SimonCahill
Copy link
Owner

Sounds good! Thanks for contributing!

I'll add you to the list of contributors and merge the PR.

@SimonCahill SimonCahill self-assigned this May 14, 2024
@SimonCahill SimonCahill added the enhancement New feature or request label May 14, 2024
@SimonCahill SimonCahill merged commit be9d46a into SimonCahill:master May 14, 2024
1 check passed
@kazetsukaimiko
Copy link
Contributor Author

Sounds good! Thanks for contributing!

I'll add you to the list of contributors and merge the PR.

Thanks, I'll be testing this library on an ESP32-S3 and may circle back for some general support there if needed.

@SimonCahill
Copy link
Owner

No problem! If you run into issues, create an Issue here and I'll help where I can.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants