Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 2e8943df37f8025148c4e2cc8cab3fb1bccfe6ff
commit2e8943df37f8025148c4e2cc8cab3fb1bccfe6ff[log] [tgz]
authorKayce Basques <kayce@pigweed.infra.roller.google.com>Thu Oct 03 15:01:37 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Oct 03 15:01:37 2024 +0000
tree87f403d5fd76afb1556b916b5e77f4e34c8ddbf4
parent2140bb6c74be6dd831503363cc701bee83ae9864 [diff]
roll: pigweed pw_env_setup: Upgrade to Sphinx v7.4.7

We need v7.4.7 (the last v7 release) to use the new Sphinx
features that were introduced in rules_python v0.36.0. These
features will be the foundation of our Bazel-based docs build
system. The new rules_python features introduced in v0.36.0
don't work with the version of Sphinx that we're currently
on (v7.1.2).

Original-Bug: 318892911
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238553
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Original-Revision: 9a5296672be32b32d684e5250b0c688ceb9206ea

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 53b16cd8d29078..9a5296672be32b
Roller-URL: https://ci.chromium.org/b/8735089144639726769
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ieff1e7e6d0e29d9fe286a6eee19e00f93efd972e
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/239772
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: 87f403d5fd76afb1556b916b5e77f4e34c8ddbf4
  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.