feat(spi): Add espp::Spi SPI component#618
Merged
Merged
Conversation
|
✅Static analysis result - no issues found! ✅ |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a new components/spi component that wraps the ESP-IDF SPI master driver in a C++ API (espp::Spi + Spi::Device) and adds a queued command/data helper intended for display-style workloads (SpiPanelIo / SpiCommandData). It also wires the new component into the documentation and CI example-build matrix so it’s published and continuously built like the other ESPP components.
Changes:
- Add the new
components/spicomponent (bus/device wrapper + queued command/data helper). - Add Sphinx/Doxygen documentation entries for the SPI component and example.
- Update CI workflows to build the new example and upload the new component.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/en/spi.rst | New SPI documentation landing page + API include. |
| doc/en/spi_example.md | Includes the SPI example README into docs. |
| doc/en/index.rst | Adds spi to the docs index toctree. |
| doc/Doxyfile | Adds SPI header + example to Doxygen inputs. |
| components/spi/src/spi.cpp | Implements espp::Spi, Spi::Device, and SpiPanelIo. |
| components/spi/include/spi.hpp | Public API for SPI wrapper + panel helper. |
| components/spi/README.md | Component overview and intended usage. |
| components/spi/idf_component.yml | Component Manager manifest for espp/spi. |
| components/spi/example/README.md | Example description. |
| components/spi/example/main/spi_example.cpp | Example demonstrating basic bus+device usage. |
| components/spi/example/main/CMakeLists.txt | Registers the example “main” component. |
| components/spi/example/CMakeLists.txt | ESP-IDF example project configuration. |
| components/spi/CMakeLists.txt | Registers the SPI component and dependencies. |
| .github/workflows/upload_components.yml | Adds components/spi to upload list. |
| .github/workflows/build.yml | Adds components/spi/example to the build matrix. |
espp::Spi SPI component'espp::Spi SPI component
Ensure the TXDATA and RXDATA spi transaction flags are ignored and only set by this transfer call Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Motivation and Context
Allows better reuse across the project for SPI and SSI devices by reducing the amount of boilerplate SPI code required for devices like encoders, IMUs, displays, etc. that might be connected over SPI.
How has this been tested?
Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):
Types of changes
Checklist:
Software
.github/workflows/build.ymlfile to add my new test to the automated cloud build github action.