Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 9e2734f98cf00ac7683e42ef49633987a7b8a1b2
commit9e2734f98cf00ac7683e42ef49633987a7b8a1b2[log] [tgz]
authorArmando Montanez <amontanez@pigweed.infra.roller.google.com>Mon Sep 30 22:38:42 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Sep 30 22:38:42 2024 +0000
tree6d9ab5d983e2134f0223104f36d297ec8360cfb9
parentb19064bd3069b1c9e23387b7a550d1e89f76983a [diff]
roll: pigweed pw_toolchain: Split out build-system specific docs

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

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 06f958a5ab8a2c..bf7078a044353d
Roller-URL: https://ci.chromium.org/b/8735331648044824161
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I011db854bbfef83cb56b829a94e24f158c1556ff
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/238878
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
1 file changed
tree: 6d9ab5d983e2134f0223104f36d297ec8360cfb9
  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.