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

feat(examples): improve example configuration #140

Merged
merged 6 commits into from
Jan 9, 2024

Conversation

finger563
Copy link
Contributor

@finger563 finger563 commented Jan 9, 2024

Description

  • Update all peripheral examples to use espp::I2c class for cleaner / more reusable code
  • Update all peripheral examples to have a Kconfig.projbuild file for configuring the i2c pins - with default hardware selecting relevant targets for the example as well as CUSTOM hardware config to configure your own i2c pins on your hardware

Motivation and Context

Simplifies the example code to make it more readable and configurable using menuconfig for targeting other hardware. Also helps make it clearer what hardware is supported by default by the example while providing code-free mechanisms for running on other hardware.

How has this been tested?

Building the examples (using this PR's GH action)

Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update
  • Hardware (schematic, board, system design) change
  • Software change

Checklist:

  • My change requires a change to the documentation.
  • I have added / updated the documentation related to this change via either README or WIKI

Software

  • I have added tests to cover my changes.
  • I have updated the .github/workflows/build.yml file to add my new test to the automated cloud build github action.
  • All new and existing tests passed.
  • My code follows the code style of this project.

* Update all peripheral examples to use espp::I2c class for cleaner / more reusable code
* Update all peripheral examples to have a Kconfig.projbuild file for configuring the i2c pins - with default hardware selecting relevant targets for the example as well as CUSTOM hardware config to configure your own i2c pins on your hardware
Copy link

github-actions bot commented Jan 9, 2024

✅Static analysis result - no issues found! ✅

@finger563 finger563 added enhancement New feature or request controller peripherals haptics bldc Related to Brushless DC Motors examples aw9523 ads7138 tla2528 TLA2528 analog/digital expander ads1x15 drv2605 mcp23x17 mt6701 st25dv ft5x06 touch driver tt21100 touch driver qwiicnes i2c gt911 touch driver bm8563 real time clock peripheral driver t-keyboard labels Jan 9, 2024
@finger563 finger563 merged commit 53fac4c into main Jan 9, 2024
23 checks passed
@finger563 finger563 deleted the feature/peripheral-example-i2c-config branch January 9, 2024 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ads1x15 ads7138 aw9523 bldc Related to Brushless DC Motors bm8563 real time clock peripheral driver controller drv2605 enhancement New feature or request examples ft5x06 touch driver gt911 touch driver haptics i2c mcp23x17 mt6701 peripherals qwiicnes st25dv t-keyboard tla2528 TLA2528 analog/digital expander tt21100 touch driver
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant