|author||Rob Mohr <firstname.lastname@example.org>||Wed Nov 25 13:50:37 2020 -0800|
|committer||CQ Bot Account <email@example.com>||Wed Nov 25 22:07:37 2020 +0000|
pw_package: Add info on enabling packages Add info() method to packages that returns a string describing how to enable the given package. Use that method at various points in the CLI (examples below). $ pw --no-banner package install nanopb 20201125 08:33:47 INF Installing nanopb... 20201125 08:33:47 INF Installing nanopb...done. 20201125 08:33:47 INF Enable with `gn gen out --args='dir_pw_third_party_nanopb="/usr/local/google/home/mohrr/pigweed/pigweed/.environment/packages/nanopb"'` $ pw --no-banner package status nanopb 20201125 08:33:52 INF nanopb is installed. 20201125 08:33:52 INF Enable with `gn gen out --args='dir_pw_third_party_nanopb="/usr/local/google/home/mohrr/pigweed/pigweed/.environment/packages/nanopb"'` $ pw --no-banner package list 20201125 08:33:55 INF Installed packages: 20201125 08:33:55 INF nanopb 20201125 08:33:55 INF Enable with `gn gen out --args='dir_pw_third_party_nanopb="/usr/local/google/home/mohrr/pigweed/pigweed/.environment/packages/nanopb"'` 20201125 08:33:55 INF 20201125 08:33:55 INF Available packages: 20201125 08:33:55 INF Change-Id: Ia3bd47250f353ea37156846ecda8fbcc7aecb0a3 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/26140 Commit-Queue: Auto-Submit <firstname.lastname@example.org> Reviewed-by: Anthony DiGirolamo <email@example.com> Pigweed-Auto-Submit: Rob Mohr <firstname.lastname@example.org>
Pigweed is an open source collection of embedded-targeted libraries--or as we like to call them, modules. These modules are building blocks and infrastructure that enable faster and more reliable development on small-footprint MMU-less 32-bit microcontrollers like the STMicroelectronics STM32L452 or the Nordic nRF52832.
Pigweed is in the early stages of development, and should be considered experimental. We’re continuing to evolve the platform and add new modules. We value developer feedback along the way.
Get the code:
git clone https://pigweed.googlesource.com/pigweed/pigweed
If you'd like to get set up with Pigweed, please visit the getting started guide.
There are many modules in Pigweed, and this section only showcases a small selection that happen to produce visual output. For more information about the different Pigweed module offerings, refer to “Module Guides” section in the full documentation.
Note: For now the full documentation is not available online; you must build it. Building the docs is easy; see the getting started guide for how.
pw_watch- Build, flash, run, & test on save
In the web development space, file system watchers are prevalent. These watchers trigger a web server reload on source change, making development much faster. In the embedded space, file system watchers are less prevalent; however, they are no less useful! The Pigweed watcher module makes it easy to instantly compile, flash, and run tests upon save. Combined with the GN-based build which expresses the full dependency tree, only the exact tests affected by a file change are run on saves.
The demo below shows
pw_watch building for a STMicroelectronics STM32F429I-DISC1 development board, flashing the board with the affected test, and verifying the test runs as expected. Once this is set up, you can attach multiple devices to run tests in a distributed manner to reduce the time it takes to run tests.
pw_presubmit- Vacuum code lint on every commit
Presubmit checks are essential tools, but they take work to set up, and projects don’t always get around to it. The
pw_presubmit module provides tools for setting up high quality presubmit checks for any project. We use this framework to run Pigweed’s presubmit on our workstations and in our automated building tools.
pw_presubmit module includes
pw format command, a tool that provides a unified interface for automatically formatting code in a variety of languages. With
pw format, you can format C, C++, Python, GN, and Go code according to configurations defined by your project.
pw format leverages existing tools like
clang-format, and it’s simple to add support for new languages.
pw_env_setup- Cross platform embedded compiler setup
A classic problem in the embedded space is reducing the time from git clone to having a binary executing on a device. The issue is that an entire suite of tools is needed for non-trivial production embedded projects. For example:
In the server space, container solutions like Docker or Podman solve this; however, in our experience container solutions are a mixed bag for embedded systems development where one frequently needs access to native system resources like USB devices, or must operate on Windows.
pw_env_setup is our compromise solution for this problem that works on Mac, Windows, and Linux. It leverages the Chrome packaging system CIPD to bootstrap a Python installation, which in turn inflates a virtual environment. The tooling is installed into your workspace, and makes no changes to your system. This tooling is designed to be reused by any project.