Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 01cd0ed15fab188890c36c11c388f5af1eab6def
commit01cd0ed15fab188890c36c11c388f5af1eab6def[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Thu Nov 14 03:20:59 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Nov 14 03:20:59 2024 +0000
tree62cff325af2a84ecbd8df8abd397344f26d30edc
parent22e0320f69bb5ea776419c55b16739b9ee000b09 [diff]
roll: pigweed b6de265..b7246bf (4 commits)

b7246bf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248195 pw_sensor: Add freeform extras field to sensor.yaml
21933c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248638 pw_async2: Accept alignment in CoroPromiseType::operator new
5b608da:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248637 pw_build: Restore layering_check workaround for pw_facade
ef6ae0d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/234930 pw_string: Stringify time types

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: b6de26528a8add..b7246bf88df6aa
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8731327548068853473
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ied7a2a46d100a46190e2bc7a36d377ba812323cc
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/248912
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: 62cff325af2a84ecbd8df8abd397344f26d30edc
  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.