Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 966bbf882c2c43537eb98c81f4d7d77f88d3ff6f
commit966bbf882c2c43537eb98c81f4d7d77f88d3ff6f[log] [tgz]
authorKayce Basques <kayce@pigweed.infra.roller.google.com>Sat Aug 16 11:23:21 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Sat Aug 16 11:23:21 2025 -0700
tree76a0705f37c75d259e928442cc1c05aa69994dec
parent949fb00aff0e18c4018d662f722dd8d9eabca641 [diff]
roll: pigweed doxygen: Migrate modules

Migrates various Pigweed modules from Breathe-style C/C++ API
references to Doxygen-style. These are most of the low-hanging
fruit.

Original-Bug: 426012010
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313133
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Original-Revision: 654b7d4504621c59664ad72171568a1da957dc0b

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 1621a81cfbd0e1..654b7d4504621c
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8706356625634596657
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I650c30fc2d5e256d4b62da04eba525e3a5b20899
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/313732
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: 76a0705f37c75d259e928442cc1c05aa69994dec
  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. .pylintrc
  18. AUTHORS
  19. BUILD.bazel
  20. CONTRIBUTING.md
  21. LICENSE
  22. MODULE.bazel
  23. MODULE.bazel.lock
  24. mypy.ini
  25. OWNERS
  26. pigweed.json
  27. 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.