tree: 6388df0014e5e3845ffd1332bedf7e3a788c2117 [path history] [tgz]
  1. docs/
  2. pw_assert/
  3. pw_assert_basic/
  4. pw_base64/
  5. pw_bloat/
  6. pw_boot_armv7m/
  7. pw_build/
  8. pw_checksum/
  9. pw_cli/
  10. pw_containers/
  11. pw_cpu_exception/
  12. pw_cpu_exception_armv7m/
  13. pw_docgen/
  14. pw_doctor/
  15. pw_dumb_io/
  16. pw_dumb_io_baremetal_stm32f429/
  17. pw_dumb_io_stdio/
  18. pw_env_setup/
  19. pw_kvs/
  20. pw_log/
  21. pw_log_basic/
  22. pw_minimal_cpp_stdlib/
  23. pw_module/
  24. pw_polyfill/
  25. pw_preprocessor/
  26. pw_presubmit/
  27. pw_protobuf/
  28. pw_protobuf_compiler/
  29. pw_span/
  30. pw_status/
  31. pw_string/
  32. pw_target_runner/
  33. pw_tokenizer/
  34. pw_toolchain/
  35. pw_unit_test/
  36. pw_varint/
  37. pw_watch/
  38. targets/
  39. .clang-format
  40. .gitignore
  41. .gn
  42. .pylintrc
  44. BUILD
  47. CMakeLists.txt
  51. modules.gni
  52. pw_vars_default.gni


Pigweed is a collection of embedded-focused libraries, called “modules”. These modules are designed for small-footprint MMU-less microcontrollers like the ST Micro STM32L452 or the Nordic NRF82832. The modules are designed to facilitate easy integration into existing codebases.

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.

Pigweed is an open source project with a code of conduct that we expect everyone who interacts with the project to respect.

Getting Started

$ git clone sso:// ~/pigweed
$ cd ~/pigweed
# Only need to run auth-login once per machine.
$ pw_env_setup/py/pw_env_setup/cipd_setup/ auth-login
$ . pw_env_setup/

You can use . pw_env_setup/ in place of . pw_env_setup/ Both should work every time, but tends to remove and reinstall things at the expense of time whereas assumes things have already been installed and only sets environment variables.

If you‘re using Homebrew and you get an error saying module 'http.client' has no attribute 'HTTPSConnection' then your Homebrew Python was not set up to support SSL. Ensure it’s installed with brew install openssl and then run brew uninstall python && brew install python. After that things should work.

The environment setup script will pull down the versions of tools necessary to build Pigweed and add them to your environment. You can then build with GN, CMake, or Bazel. You can also confirm you're getting the right versions of tools—they should be installed under .cipd/.

Build for the host with GN

$ which gn
$ gn gen out/host
$ ninja -C out/host

Build for the host with CMake

$ which cmake
$ cmake -B out/cmake-host -S . -G Ninja
$ ninja -C out/cmake-host

Build for the host with Bazel

$ which bazel
$ bazel test //...

Build for the STM32F429 Discovery board

$ gn gen --args='pw_target_config = "//targets/stm32f429i-disc1/target_config.gni"' out/disco
$ ninja -C out/disco
$ pw test --root out/disco/ --runner stm32f429i_disc1_unit_test_runner

Build upstream Pigweed documentation

$ gn gen --args='pw_target_config = "//targets/docs/target_config.gni"' out/docs
$ ninja -C out/docs
$ google-chrome out/docs/gen/docs/html/index.html

The CMake and Bazel builds do not yet support building for hardware.

To flash firmware to an STM32 Discovery development board (and run pw test) from macOS, you need to install OpenOCD. Install Homebrew using the latest instructions at, then install OpenOCD with brew install openocd.

If any of this doesn't work please file a bug.