Google Git
Sign in
pigweed / pigweed / quickstart / bazel / bbad65d282314c0a715976bf377b855c376b91e3
commitbbad65d282314c0a715976bf377b855c376b91e3[log] [tgz]
authorJonathon Reinhart <jrreinhart@pigweed.infra.roller.google.com>Tue Jan 14 09:35:56 2025 -0800
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Jan 14 09:35:56 2025 -0800
treec4232ee9a4a920407e66265286be050f07f8598e
parentbd4f25700a5febf81e12a19e0dccb5b299f104b2 [diff]
roll: pigweed pw_digital_io_mcuxpresso: Update docs

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

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: bc21d0aeb6e93a..2b3049b1573b8c
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8725747230566945873
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I69be4713b27b6a450be3fe1290a30065234f5436
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/260139
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: c4232ee9a4a920407e66265286be050f07f8598e
  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.