Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 2140bb6c74be6dd831503363cc701bee83ae9864
commit2140bb6c74be6dd831503363cc701bee83ae9864[log] [tgz]
authorArmando Montanez <amontanez@pigweed.infra.roller.google.com>Wed Oct 02 22:22:44 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Oct 02 22:22:44 2024 +0000
treec021293cdba99db10c7d01917667261b644e64bc
parentd32b4341b23777b27d3e0279bbb3fce2ca529426 [diff]
roll: pigweed pw_build: Break apart pigweed.bzl

Overtime, Pigweed unintentionally grew a `pigweed.bzl` file that ended
up being a grab-bag of various Bazel rules. This change breaks up this
file to mirror GN by moving rules into their own individual files,
moving to different modules where appropriate.

Original-Bug: b/370792896
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239133
Original-Revision: 53b16cd8d2907855b13bec9159286927de602a72

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 547e0582fa65c3..53b16cd8d29078
Roller-URL: https://ci.chromium.org/b/8735151260283828785
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I6a37af566ddc5fe95beb5295d67a30b050741732
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/239592
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: c021293cdba99db10c7d01917667261b644e64bc
  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.