Google Git
Sign in
opensecura / 3p / google / pigweed / 8635af956bdb695f1cc7fb59a1be12d80b25f589
commit8635af956bdb695f1cc7fb59a1be12d80b25f589[log] [tgz]
authorWyatt Hepler <hepler@google.com>Thu Dec 05 16:32:44 2019 -0800
committerWyatt Hepler <hepler@google.com>Thu Dec 05 16:33:33 2019 -0800
tree4c444dff1b6a2925532b56d064fb211b44efc552
parentbecb431e5fea14de1577d96bb16f8cac87b895d3 [diff]
Update Sphinx conf.py; add autodoc extension

Change-Id: I4754d7d2203da2d9364d11aca65474eb29505fbf
2 files changed
tree: 4c444dff1b6a2925532b56d064fb211b44efc552
  1. docs/
  2. env_setup/
  3. pw_bloat/
  4. pw_build/
  5. pw_cli/
  6. pw_docgen/
  7. pw_dumb_io/
  8. pw_dumb_io_baremetal_stm32f429/
  9. pw_dumb_io_stdio/
  10. pw_module/
  11. pw_preprocessor/
  12. pw_presubmit/
  13. pw_span/
  14. pw_status/
  15. pw_string/
  16. pw_toolchain/
  17. pw_unit_test/
  18. pw_varint/
  19. targets/
  20. .clang-format
  21. .gitignore
  22. .gn
  23. .pylintrc
  24. AUTHORS
  25. BUILD
  26. BUILD.gn
  27. BUILDCONFIG.gn
  28. CONTRIBUTING.md
  29. LICENSE
  30. modules.gni
  31. pw_vars_default.gni
  32. README.md
  33. WORKSPACE
README.md

Pigweed Embedded Oriented Software Libraries

Pigweed is a collection of embedded-focused libraries, which we call “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.

Getting Started

$ git clone sso://pigweed.googlesource.com/pigweed/pigweed ~/pigweed
$ cd ~/pigweed
$ env_setup/cipd/cipd.py auth-login  # Once per machine.
$ . env_setup/setup.sh

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 either GN or Bazel. You can also confirm you're getting the right versions of tools—they should be installed under env_setup/.

$ which gn
~/pigweed/env_setup/cipd/tools/gn
$ gn gen out/host
$ ninja -C out/host

$ which bazel
~/pigweed/env_setup/cipd/tools/bazel
$ bazel test //...

And do the following to test on the STM32F429 Discovery board. (The bazel build does not yet support building for hardware.)

$ 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 -- --port /dev/ttyACM0

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