Google Git
Sign in
pigweed / pigweed / quickstart / bazel / c26ec3ffa9eac29e9c3538faecbe3dc3aa66909d
commitc26ec3ffa9eac29e9c3538faecbe3dc3aa66909d[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>Wed Oct 23 08:00:51 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Oct 23 08:00:51 2024 +0000
tree21badc398ca3fb5c605046c625b42288b8030a94
parente36f0cb1a9ba997a6969207d34326afa0e0e6af2 [diff]
roll: pigweed c5e6cab..5e55f79 (3 commits)

5e55f79:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243152 SEED-0132: Claim SEED number
ec55b9c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242932 pw_metric: Specify language on code blocks
07d1278:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243997 docs: Shorten Sense link to just "Tour"

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: c5e6cab3b190f4..5e55f7931a6895
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8733305590132385505
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ie624413f63b7e31d67cfaec1fbd539d36e44d68a
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/243810
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: 21badc398ca3fb5c605046c625b42288b8030a94
  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.