Google Git
Sign in
pigweed / pigweed / quickstart / bazel / e6e3f5a2a2a8e78a1bd8108eac73ff5b4572c091
commite6e3f5a2a2a8e78a1bd8108eac73ff5b4572c091[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Thu Oct 10 21:35:13 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Oct 10 21:35:13 2024 +0000
treec58462ff563dcdb5db2dd205f9e5e5d2fae9d1f3
parent4bcce8e600564f35b5080600993df3d1b3593fab [diff]
roll: pigweed a789e9c..bdcf658 (2 commits)

bdcf658:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238572 pw_uart: Add UartNonBlocking::FlushOutput()
840c58d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241199 pw_uart: Update OWNERS

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: a789e9c308f3b2..bdcf6585021337
Roller-URL: https://ci.chromium.org/b/8734429733176069137
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Iec4c981c877a3f593e3a58e821590e8b23501d2d
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/241572
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: c58462ff563dcdb5db2dd205f9e5e5d2fae9d1f3
  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.