| commit | b9690ce106fc7b3080805a002a4b9fa3f54f6ce9 | [log] [tgz] |
|---|---|---|
| author | Kayce Basques <kayce@pigweed.infra.roller.google.com> | Thu Nov 21 19:28:34 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Nov 21 19:28:34 2024 +0000 |
| tree | b1abe80eed0d83dc5f3c4d80c749c87a195f365d | |
| parent | 899970c76a75648dd8da29ee74a3521600118f1f [diff] |
roll: pigweed docs: Normalize SEED filenames Currently SEED filenames start with the SEED number but then include arbitrary text, e.g. 0002-template.rst. Automation of the SEED index will be easier if we normalize the filenames to only include the number, e.g. 0002.rst. SEED URLs will also be more predictable, e.g. pigweed.dev/seed/0002.html. This is prereq work for the migration of the docgen system to Bazel; it will be hard to migrate the SEED index auto-generation to Bazel if we don't make this change. Original-Bug: 318892911 Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248452 Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Original-Revision: f4e18d1488c9d462a0d0da3342763a8864cb5200 Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 55f09ff7516de0..f4e18d1488c9d4 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8730632405776204081 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ic8fed217606fa49ead5f99ab9b4614f190ae71da Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/quickstart/bazel/+/250395 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>
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.