Google Git
Sign in
pigweed / pigweed / quickstart / bazel / b51447a4b9d51a49bc563fc63e061fbfbb1bc0e8
commitb51447a4b9d51a49bc563fc63e061fbfbb1bc0e8[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Mon Nov 04 21:10:27 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Nov 04 21:10:27 2024 +0000
treed5d803603e6bfce3a0bf438c7f0ee724e3fb7085
parent0a620cdf6f8b77833a8b0676d380177ec10a5a60 [diff]
roll: pigweed 54ca0db..4fbb15f (5 commits)

4fbb15f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246735 pw_{async2,channel}: Start FAQ sections
1c6d9e8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246733 pw_docgen: Remove 11/18/2024 PW Live
2fd2d13:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246498 pw_log_basic: Add pw_log_string handler backend
6a16fab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246692 pw_protobuf: Allow unset oneof callbacks
1dcac6a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246412 pw_allocator: Separate PMR from Allocator

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