Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 4996766cb6c4f59743475f0a3177b2408fd91f7f
commit4996766cb6c4f59743475f0a3177b2408fd91f7f[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Tue Sep 17 17:55:09 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Sep 17 17:55:09 2024 +0000
treeadc68733c370ec44c1f14f58862c6a428802cba1
parent46f81bd72d45658febff7eb56a6265092a7671c6 [diff]
roll: pigweed bbe5cd6..9d17506 (2 commits)

9d17506:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/236232 pw_spi_mcuxpresso: Rename DoConfigure() to DoConfigureLocked()
a14882b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/236292 pw_spi: Minor doc enhancements

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: bbe5cd6062a860..9d175062d56972
Roller-URL: https://ci.chromium.org/b/8736527073667402801
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I52415383d77e61c5a3ef69d12094dd1d880cf5b0
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/236474
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: adc68733c370ec44c1f14f58862c6a428802cba1
  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.