Google Git
Sign in
pigweed / pigweed / quickstart / bazel / b92b055d1f81a5f9b393c00f54693ff17d2cce82
commitb92b055d1f81a5f9b393c00f54693ff17d2cce82[log] [tgz]
authorKayce Basques <kayce@pigweed.infra.roller.google.com>Sat Oct 05 01:11:51 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Sat Oct 05 01:11:51 2024 +0000
treeb1e777057606472a771e3a7c26458cb63cdccc91
parent5651d0890d2e34d2092675a9ec90c7d11758da67 [diff]
roll: pigweed docs: Introduce Bazel-based docgen

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

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 1767a9b4087e81..819e758453a9b4
Roller-URL: https://ci.chromium.org/b/8734959493887598561
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I3063fbe7ef49d3639d17453577a107e57dea19ad
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/240272
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: b1e777057606472a771e3a7c26458cb63cdccc91
  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.