roll: pigweed 3c7eaef..d29fcf1 (2 commits)

d29fcf1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319819 pw_async2: Update docs
efc8002:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318654 doxygen: Update pw_result and pw_status aliases

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 3c7eaef0e7fbea..d29fcf1a934365
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8704061515895068449
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I71019f87b43ac624fae0d07209aeb0f82195bbde
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/321125
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: 80a9e1761c94b7839380c4ed73aea58794007ccf
  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. .clang-tidy
  14. .clangd.shared
  15. .gitignore
  16. .pw_console.yaml
  17. .pylintrc
  18. AUTHORS
  19. BUILD.bazel
  20. CONTRIBUTING.md
  21. LICENSE
  22. MODULE.bazel
  23. MODULE.bazel.lock
  24. mypy.ini
  25. OWNERS
  26. pigweed.json
  27. 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.