Google Git
Sign in
pigweed / pigweed / quickstart / bazel / ca36cd7909ee5b6fdefc9bf21f314695cee4a3a2
commitca36cd7909ee5b6fdefc9bf21f314695cee4a3a2[log] [tgz]
authorKayce Basques <kayce@pigweed.infra.roller.google.com>Thu Sep 19 22:30:46 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Sep 19 22:30:46 2024 +0000
tree6284728dcfce097227451f277b92fa23e9e9d84c
parent6e84dd4035131c69b2a70eccf9e3cf3e1f8d7f61 [diff]
roll: pigweed docs: Remove borders from inline code

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

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 213b6e1e533e64..fd5c648a333b9e
Roller-URL: https://ci.chromium.org/b/8736328531264994817
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I4d99b37f8bdaf6bc55edf289025e0157808b2445
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/236785
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 6284728dcfce097227451f277b92fa23e9e9d84c
  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.