Google Git
Sign in
opensecura / 3p / google / pigweed / d2e4903a42a6379fbe08f364490046a8f3bdf3d1
commitd2e4903a42a6379fbe08f364490046a8f3bdf3d1[log] [tgz]
authorArmando Montanez <amontanez@google.com>Fri Dec 06 13:06:01 2019 -0800
committerArmando Montanez <amontanez@google.com>Tue Dec 10 00:05:55 2019 +0000
treed2b0971d109c514f8493273c7f0fa83dcc7ebd0a
parent8edfeaeec06c7e14808e44b0bb7d071e2e03b01e [diff]
pw_dumb_io: Update docs

Add/update docs for the pw_dumb_io facade and backends. Configures GN
build files such that all the backend docs are built even if the backend
isn't in use.

Change-Id: I91fca1cb2d3f5d4b57ae1f6991a89270a35be1c6
8 files changed
tree: d2b0971d109c514f8493273c7f0fa83dcc7ebd0a
  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_test_server/
  17. pw_toolchain/
  18. pw_unit_test/
  19. pw_varint/
  20. targets/
  21. .clang-format
  22. .gitignore
  23. .gn
  24. .pylintrc
  25. AUTHORS
  26. BUILD
  27. BUILD.gn
  28. BUILDCONFIG.gn
  29. CONTRIBUTING.md
  30. LICENSE
  31. modules.gni
  32. pw_vars_default.gni
  33. README.md
  34. 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.