Google Git
Sign in
pigweed / pigweed / quickstart / bazel / b8f9a855569d7fd344dbf26952857819fda9fbe8
commitb8f9a855569d7fd344dbf26952857819fda9fbe8[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Tue Feb 11 15:45:48 2025 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Feb 11 15:45:48 2025 -0800
treed46d7129606697c4446c78c0b542d627de433802
parent7627d34b43f850a85528d430ee5aabba5fb6a31e [diff]
roll: pigweed 6aeb739..b393232 (2 commits)

b393232:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/267332 pw_env_setup: Include hidden packages in check
63fde05:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/267232 pw_kernel: Add cheat sheet docs

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 6aeb739dcb7ea8..b39323232ddb3f
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8723187300439866209
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I681ec7d91a703a948811f7fb7e94d7faccbe6385
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/267372
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: d46d7129606697c4446c78c0b542d627de433802
  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. .clang-tidy
  14. .clangd.shared
  15. .gitignore
  16. .pw_console.yaml
  17. AUTHORS
  18. BUILD.bazel
  19. CONTRIBUTING.md
  20. LICENSE
  21. MODULE.bazel
  22. MODULE.bazel.lock
  23. OWNERS
  24. pigweed.json
  25. 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.