Google Git
Sign in
pigweed / pigweed / quickstart / bazel / 8e3014867f157f9ba1b83981b4d55b69082b0327
commit8e3014867f157f9ba1b83981b4d55b69082b0327[log] [tgz]
authorAaron Green <aarongreen@pigweed.infra.roller.google.com>Thu Sep 26 18:10:29 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Sep 26 18:10:29 2024 +0000
treeaf46be5c178c86610071cc7d65558068af2c8f0d
parentdb35d9cb4e4b1ddf2b5e1aacb84183b331e1802a [diff]
roll: pigweed pw_containers: Fix intrusive map docs

Doxygen seems to be mishandling the \copydoc directives on a templated
class. For now, this CL avoids using \copydoc in order to having working
docs at the cost of some duplication.

Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/237612
Original-Revision: ce337e5ea22fe0c9fc0a88d14b1afde2ca3f1818

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: d647f5e5df848f..ce337e5ea22fe0
Roller-URL: https://ci.chromium.org/b/8735710782487842337
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I800cbc24fd53774d6464d9dcba0c2296f73d20ae
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/238157
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: af46be5c178c86610071cc7d65558068af2c8f0d
  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.