|author||Armando Montanez <firstname.lastname@example.org>||Mon Mar 02 14:58:59 2020 -0800|
|committer||CQ Bot Account <email@example.com>||Tue Mar 03 18:19:17 2020 +0000|
Rename pw_dumb_io to pw_sys_io Rename pw_dumb_io facade and backends to use the more deliberate name pw_sys_io moving forward. Change-Id: I968480715967ab8de491856afa1b7692b973ed7e
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.
$ git clone sso://pigweed.googlesource.com/pigweed/pigweed ~/pigweed $ cd ~/pigweed # Only need to run auth-login once per machine. $ pw_env_setup/py/pw_env_setup/cipd_setup/wrapper.py auth-login $ . pw_env_setup/bootstrap.sh
You can use
. pw_env_setup/setup.sh in place of
. pw_env_setup/bootstrap.sh. Both should work every time, but
bootstrap.sh tends to remove and reinstall things at the expense of time whereas
setup.sh 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
Build for the host with GN
$ which gn ~/pigweed/.cipd/pigweed.ensure/gn $ gn gen out/host $ ninja -C out/host
Build for the host with CMake
$ which cmake ~/pigweed/.cipd/pigweed.ensure/bin/cmake $ cmake -B out/cmake-host -S . -G Ninja $ ninja -C out/cmake-host
Build for the host with Bazel
$ which bazel ~/pigweed/.cipd/pigweed.ensure/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 https://brew.sh/, then install OpenOCD with
brew install openocd.
If any of this doesn't work please file a bug.