Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 567215201c4f0fb1bac5843f17df5795e9bf4f23
commit567215201c4f0fb1bac5843f17df5795e9bf4f23[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Tue Sep 24 22:00:28 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Sep 24 22:00:28 2024 +0000
tree350673388f72b8b1b1022540261d788d903545a7
parentaaec716a3a4df68b014089837535e0653b48e882 [diff]
roll: pigweed ca679a2..94d2c39 (2 commits)

94d2c39:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/237394 pw_uart_mcuxpresso: Fix disable bug
5bf0e36:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/237412 pw_bluetooth_sapphire: Document clangd configuration

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: ca679a238320e2..94d2c3995c8a14
Roller-URL: https://ci.chromium.org/b/8735877513534517281
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I123658c2b5f2c10428754e11c4fb4aad491bc0fb
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/237734
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 350673388f72b8b1b1022540261d788d903545a7
  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.