Google GitGoogle Git
Sign in
pigweed/pigweed/quickstart/bazel/b17df609d293817e634763692f98ffbf7350dc3b
commit
b17df609d293817e634763692f98ffbf7350dc3b
[log]
author
Kayce Basques <kayce@pigweed.infra.roller.google.com>
Mon Oct 05 18:38:58 2026 -0700
committer
CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Mon Oct 05 18:38:58 2026 -0700
tree
f5954cf95b09be784a247b4c87a0c0b206d01c98
parent
1102588e0bdbb14ca434c843f56e91f77b3c9646 [diff]
roll: pigweed docs: Update sitemap generator

The old logic relied on Sphinx-generated docnames,
which limits the sitemap to Sphinx-generated URLs.
The new logic recursively walks the output directory
in order to detect pages generated by rustdoc and
Doxygen. Aside from improving SEO, having a complete
sitemap can also be useful for integration tests and
migration verification workflows.

Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/494433
Original-Revision: d030d83c44a255e3b2b920272cf68d9212058ad7

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: cc9a128a107061..d030d83c44a255
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8668731675257663665
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I21e7e5e89a54ae29863f0671ca334898d3f3ca51
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/495073
1 file changed
tree: f5954cf95b09be784a247b4c87a0c0b206d01c98
  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. pw
  27. README.md
  28. workflows.json
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.