xref: /aosp_15_r20/external/pigweed/docs/os/zephyr/index.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1.. _docs-os-zephyr:
2
3======
4Zephyr
5======
6Pigweed has preliminary support for `Zephyr <https://www.zephyrproject.org/>`_.
7See the docs for these modules for more information:
8
9- :ref:`pw_assert_zephyr <module-pw_assert_zephyr>`
10- :ref:`pw_chrono_zephyr <module-pw_chrono_zephyr>`
11- :ref:`pw_interrupt_zephyr <module-pw_interrupt_zephyr>`
12- :ref:`pw_log_zephyr <module-pw_log_zephyr>`
13- :ref:`pw_sync_zephyr <module-pw_sync_zephyr>`
14- :ref:`pw_sys_io_zephyr <module-pw_sys_io_zephyr>`
15- :ref:`pw_thread_zephyr <module-pw_thread_zephyr>`
16
17.. note:: The version of Zephyr bundled with `pw package install zephyr` is
18   being migrated to v3.6 as we near the latest release.
19
20.. _docs-os-zephyr-get-started:
21
22-----------------------------------
23Get started with Zephyr and Pigweed
24-----------------------------------
251. Check out the `zephyr_pigweed`_ repository for an example of a Zephyr starter
26   project that has been set up to use Pigweed.
272. See :ref:`docs-os-zephyr-kconfig` to find the Kconfig options for
28   enabling individual Pigweed modules and features.
29
30-------
31Testing
32-------
33To test against Zephyr, first go through the `zephyr_pigweed`_ tutorial.
34Once set up, simply invoke:
35
36.. code-block:: bash
37
38   $ source ${PW_ROOT}/activate.sh
39   $ west twister -T ${PW_ROOT}
40
41.. attention:: Testing has only been verified with `-p native_posix`. Proceed with caution.
42
43.. _zephyr_pigweed: https://github.com/yperess/zephyr-pigweed/
44
45.. toctree::
46   :hidden:
47
48   kconfig
49