Google Git
Sign in
pigweed / pigweed / quickstart / bazel / af067c3362620ac12fd957d093b5d8553257da82
commitaf067c3362620ac12fd957d093b5d8553257da82[log] [tgz]
authorJonathon Reinhart <jrreinhart@pigweed.infra.roller.google.com>Wed Oct 09 17:56:19 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Oct 09 17:56:19 2024 +0000
treee5184bd255a8c65c5f11e8c93081f1a9e55c2cda
parent048f75fd0de43d8efa70279aed1c01f2322bfdd6 [diff]
roll: pigweed pw_spi: Use non-virtual interface (NVI) pattern on pw::spi::Initiator

The public interface is no longer virtual, and implementations instead
implement Do* versions of those methods.

This allows the base class to add common functionality.

Original-Bug: 308479791
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/236234
Original-Revision: 4321a46654fae21df8e8fb971cd5c618b8b73d3f

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 1e33c23b76d2e9..4321a46654fae2
Roller-URL: https://ci.chromium.org/b/8734533988233259633
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Id6ff35f9564ca2e7b6b2d355bd126c396f057e21
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/241041
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
1 file changed
tree: e5184bd255a8c65c5f11e8c93081f1a9e55c2cda
  1. .github/
  2. .vscode/
  3. apps/
  4. modules/
  5. system/
  6. targets/
  7. tools/
  8. .bazelignore
  9. .bazelrc
  10. .bazelversion
  11. .buildifier.json
  12. .clang-format
  13. .clangd.shared
  14. .gitignore
  15. .pw_console.yaml
  16. AUTHORS
  17. BUILD.bazel
  18. CONTRIBUTING.md
  19. LICENSE
  20. MODULE.bazel
  21. OWNERS
  22. pigweed.json
  23. README.md
README.md

Pigweed: minimal Bazel example

This repository contains a minimal example of a Bazel-based Pigweed project. It is a LED-blinking service (featuring RPC control!) for the Raspberry Pi Pico. It can also be run on any computer using the included simulator.

Getting the code

git clone https://pigweed.googlesource.com/pigweed/quickstart/bazel pw_bazel_quickstart
cd pw_bazel_quickstart

Dependencies

The only dependency that must be installed is Bazelisk.

Bazelisk is a launcher for the Bazel build system that allows for easy management of multiple Bazel versions.

Instructions for installing Bazelisk can be found here.

Running on the simulator

To run the simulator, type: bazelisk run //apps/blinky:simulator_blinky Then, in a new console, connect to the simulator using: bazelisk run //apps/blinky:simulator_console

Running on hardware

To start, connect a Raspberry Pi Pico, Pico 2, or debug probe via USB.

To run on the Raspberry Pi Pico, type: bazelisk run //apps/blinky:flash_rp2040 Then, in a new console, connect to the device using: bazelisk run //apps/blinky:rp2040_console

Controlling the LED

Once connected with a console, RPCs can be sent to control the LED. Try running:

device.set_led(True)
device.set_led(False)
device.toggle_led()
device.blink(blink_count=3)

Running unit tests on the host device

bazelisk test //... will run the unit tests defined in this project, such as the ones in modules/blinky/blinky_test.cc.

Running unit tests on hardware

bazelisk run @pigweed//targets/rp2040/py:unit_test_server in one console followed by bazelisk test //... --config=rp2040 will also allow running the unit tests on-device.

Next steps

Try poking around the codebase for inspiration about how Pigweed projects can be organized. Most of the relevant code in this quickstart (including RPC definitions) is inside modules/blinky, with some client-side Python code in tools/console.py.