Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 8f1a122e59129263b820799a0a46038ef789bec1
commit8f1a122e59129263b820799a0a46038ef789bec1[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Tue Jan 28 12:41:57 2025 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Jan 28 12:41:57 2025 -0800
tree1e7a0ef6e084a59a2caabdb790ab14643b186b65
parent6aa338d4917762b3e78d442d5eb6b6c2cf6cdf92 [diff]
roll: pigweed 91effbe..dff9ccc (4 commits)

dff9ccc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/263132 docs: Treat warnings as errors in the Bazel build
2b29b9b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/262924 pw_cli: Move file_summary
46c7ea9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260092 pw_toolchain: Support building Rust libcore from source
1b93cc9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/263094 docs: Use the same Doxygen version on all platforms

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 91effbebe64f1d..dff9ccc642ac3b
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8724467297358070337
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ic28a671f13e8c5c44e194e6435876dc9e599178c
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/263213
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
2 files changed
tree: 1e7a0ef6e084a59a2caabdb790ab14643b186b65
  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. MODULE.bazel.lock
  22. OWNERS
  23. pigweed.json
  24. 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.