Google Git
Sign in
pigweed / pigweed / pigweed / d38649a6783ca652b3dfd3bfb2fa7aa0bddebcf7
commitd38649a6783ca652b3dfd3bfb2fa7aa0bddebcf7[log] [tgz]
authorpigweed-roller <pigweed-roller@pigweed.google.com.iam.gserviceaccount.com>Sun Dec 27 06:02:00 2020 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Sun Dec 27 06:16:21 2020 +0000
treec66b6c3ebdaf1838df42beef8dbd044bd030c502
parent1627b0886da4f5810f0024e5cf4c839f72021122 [diff]
roll: gn

From: git_revision:4e260f1dc17864cdedc31bec1ff658404a9d703e
To: git_revision:0d67e272bdb8145f87d238bc0b2cb8bf80ccec90

CQ-Do-Not-Cancel-Tryjobs: true
Roller-URL: https://ci.chromium.org/b/8859783731965904064
Cq-Cl-Tag: roller-builder:gn-roller
Cq-Cl-Tag: roller-bid:8859783731965904064
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I060d3b60ae6333713ff5baf912ee599c36e1c24e
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/28420
Reviewed-by: Pigweed Roller <pigweed-roller@pigweed.google.com.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed.google.com.iam.gserviceaccount.com>
1 file changed
tree: c66b6c3ebdaf1838df42beef8dbd044bd030c502
  1. build_overrides/
  2. docker/
  3. docs/
  4. pw_allocator/
  5. pw_arduino_build/
  6. pw_assert/
  7. pw_assert_basic/
  8. pw_assert_log/
  9. pw_base64/
  10. pw_bloat/
  11. pw_blob_store/
  12. pw_boot_armv7m/
  13. pw_build/
  14. pw_bytes/
  15. pw_checksum/
  16. pw_chrono/
  17. pw_chrono_freertos/
  18. pw_chrono_stl/
  19. pw_chrono_threadx/
  20. pw_cli/
  21. pw_containers/
  22. pw_cpu_exception/
  23. pw_cpu_exception_armv7m/
  24. pw_cpu_exception_cortex_m/
  25. pw_docgen/
  26. pw_doctor/
  27. pw_env_setup/
  28. pw_fuzzer/
  29. pw_hdlc_lite/
  30. pw_hex_dump/
  31. pw_i2c/
  32. pw_interrupt/
  33. pw_interrupt_cortex_m/
  34. pw_kvs/
  35. pw_log/
  36. pw_log_basic/
  37. pw_log_multisink/
  38. pw_log_null/
  39. pw_log_rpc/
  40. pw_log_tokenized/
  41. pw_malloc/
  42. pw_malloc_freelist/
  43. pw_metric/
  44. pw_minimal_cpp_stdlib/
  45. pw_module/
  46. pw_package/
  47. pw_polyfill/
  48. pw_preprocessor/
  49. pw_presubmit/
  50. pw_protobuf/
  51. pw_protobuf_compiler/
  52. pw_random/
  53. pw_result/
  54. pw_ring_buffer/
  55. pw_rpc/
  56. pw_span/
  57. pw_status/
  58. pw_stream/
  59. pw_string/
  60. pw_sync/
  61. pw_sync_freertos/
  62. pw_sync_stl/
  63. pw_sync_threadx/
  64. pw_sys_io/
  65. pw_sys_io_arduino/
  66. pw_sys_io_baremetal_lm3s6965evb/
  67. pw_sys_io_baremetal_stm32f429/
  68. pw_sys_io_stdio/
  69. pw_target_runner/
  70. pw_tokenizer/
  71. pw_toolchain/
  72. pw_trace/
  73. pw_trace_tokenized/
  74. pw_unit_test/
  75. pw_varint/
  76. pw_watch/
  77. pw_web_ui/
  78. targets/
  79. third_party/
  80. .dockerignore ⇨ .gitignore
  81. activate.sh ⇨ bootstrap.sh
  82. .bazelignore
  83. .clang-format
  84. .eslintrc.json
  85. .gitattributes
  86. .gitignore
  87. .gn
  88. .prettierrc.js
  89. .pylintrc
  90. activate.bat
  91. AUTHORS
  92. bootstrap.bat
  93. bootstrap.sh
  94. BUILD
  95. BUILD.gn
  96. BUILDCONFIG.gn
  97. CMakeLists.txt
  98. CODE_OF_CONDUCT.md
  99. CONTRIBUTING.md
  100. LICENSE
  101. modules.gni
  102. OWNERS
  103. package.json
  104. PW_PLUGINS
  105. README.md
  106. tsconfig.json
  107. WORKSPACE
  108. yarn.lock
README.md

Pigweed

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.

Quick links

Get the code: git clone https://pigweed.googlesource.com/pigweed/pigweed

Getting Started

If you'd like to get set up with Pigweed, please visit the getting started guide.

What does Pigweed offer?

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 watch running on-device 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.

The 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 presubmit demo

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:

  • A C++ compiler for your target device, and also for your host
  • A build system or three; for example, GN, Ninja, CMake, Bazel
  • A code formatting program like clang-format
  • A debugger like OpenOCD to flash and debug your embedded device
  • A known Python version with known modules installed for scripting
  • A Go compiler for the Go-based command line tools
  • ... and so on

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.