| commit | 920bceb90b3d0ec3e7515b0534086a6d3471751e | [log] [tgz] |
|---|---|---|
| author | Kayce Basques <kayce@pigweed.infra.roller.google.com> | Thu Aug 07 22:45:44 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Aug 07 22:45:44 2025 -0700 |
| tree | 93d909588f9aa6eb3ab0c416ed6cb75ee1ef319b | |
| parent | 901f325716f64e80c47651d7886361a2cedf2907 [diff] |
roll: pigweed doxygen: Show only the home and modules tabs By default, Doxygen lets you browse an API in many different ways. E.g. you can browse by namespace, class, struct, etc. For now, we should disable all these alternative navigation schemas and make sure that each API item is correctly listed under the Pigweed module where that API item is exposed. At a later date we can re-enable the alternative organization schemas if a need arises. Original-Bug: 426012010 Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311320 Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Original-Revision: 2b23689560196ea206283712f65093f3d48ab148 Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 9b9b629a122fd9..2b23689560196e Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8707129017925692977 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I079385668c956465d1f95ae799b812b6c4127e55 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/311279 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
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.
git clone https://pigweed.googlesource.com/pigweed/quickstart/bazel pw_bazel_quickstart cd pw_bazel_quickstart
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.
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
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
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)
bazelisk test //... will run the unit tests defined in this project, such as the ones in modules/blinky/blinky_test.cc.
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.
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.