Lines Matching +full:python +full:- +full:version
8 - Set up a command-line Zephyr development environment on Ubuntu, macOS, or
11 - Get the source code
12 - Build, flash, and run a sample application
23 .. group-tab:: Ubuntu
25 This guide covers Ubuntu version 20.04 LTS and later.
28 .. code-block:: bash
33 .. group-tab:: macOS
39 <https://support.apple.com/en-us/HT201541>`_.
41 .. group-tab:: Windows
46 .. _install-required-tools:
53 The current minimum required version for the main dependencies are:
55 .. list-table::
56 :header-rows: 1
58 * - Tool
59 - Min. Version
61 * - `CMake <https://cmake.org/>`_
62 - 3.20.5
64 * - `Python <https://www.python.org/>`_
65 - 3.10
67 * - `Devicetree compiler <https://www.devicetree.org/>`_
68 - 1.4.6
72 .. group-tab:: Ubuntu
76 #. If using an Ubuntu version older than 22.04, it is necessary to add extra
81 A detailed explanation of ``kitware-archive.sh`` can be found here
82 `kitware third-party apt repository <https://apt.kitware.com/>`_:
84 .. code-block:: bash
86 wget https://apt.kitware.com/kitware-archive.sh
87 sudo bash kitware-archive.sh
91 .. code-block:: bash
93 sudo apt install --no-install-recommends git cmake ninja-build gperf \
94 ccache dfu-util device-tree-compiler wget \
95 python3-dev python3-pip python3-setuptools python3-tk python3-wheel xz-utils file \
96 make gcc gcc-multilib g++-multilib libsdl2-dev libmagic1
100 Due to the unavailability of ``gcc-multilib`` and ``g++-multilib`` on AArch64
105 .. code-block:: bash
107 cmake --version
108 python3 --version
109 dtc --version
115 .. group-tab:: macOS
121 .. code-block:: bash
123 … /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
125 #. After the Homebrew installation script completes, follow the on-screen
130 .. code-block:: bash
139 .. code-block:: bash
141 brew install cmake ninja gperf python3 python-tk ccache qemu dtc libmagic wget openocd
143 #. Add the Homebrew Python folder to the path, in order to be able to
144 execute ``python`` and ``pip`` as well ``python3`` and ``pip3``.
146 .. code-block:: bash
148 … (echo; echo 'export PATH="'$(brew --prefix)'/opt/python/libexec/bin:$PATH"') >> ~/.zprofile
151 .. group-tab:: Windows
158 <https://msdn.microsoft.com/en-us/commandline/wsl/install_guide>`_
163 In modern version of Windows (10 and later) it is recommended to install the Windows Terminal
179 To do so, press the Windows key, type ``cmd.exe`` or PowerShell, right-click the
186 .. code-block:: bat
188 choco feature enable -n allowGlobalConfirmation
192 .. code-block:: bat
194 choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
195 choco install ninja gperf python311 git dtc-msys2 wget 7zip strawberryperl
199 As of November 2024, Python 3.13 is not recommended for Zephyr development on Windows,
200 as some required Python dependencies may be difficult to install.
208 .. _clone-zephyr:
212 Get Zephyr and install Python dependencies
218 chosen. You'll also install Zephyr's additional Python dependencies in a
219 `Python virtual environment`_.
221 .. _Python virtual environment: https://docs.python.org/3/library/venv.html
225 .. group-tab:: Ubuntu
227 #. Use ``apt`` to install Python ``venv`` package:
229 .. code-block:: bash
231 sudo apt install python3-venv
235 .. code-block:: bash
237 python3 -m venv ~/zephyrproject/.venv
241 .. code-block:: bash
256 .. code-block:: bash
262 .. code-block:: bash
272 .. code-block:: bash
274 west zephyr-export
276 #. The Zephyr west extension command, ``west packages`` can be used to install Python
279 .. code-block:: bash
281 west packages pip --install
283 .. group-tab:: macOS
287 .. code-block:: bash
289 python3 -m venv ~/zephyrproject/.venv
293 .. code-block:: bash
308 .. code-block:: bash
314 .. code-block:: bash
324 .. code-block:: bash
326 west zephyr-export
328 #. The Zephyr west extension command, ``west packages`` can be used to install Python
331 .. code-block:: bash
333 west packages pip --install
335 .. group-tab:: Windows
343 .. code-tab:: bat
346 python -m venv zephyrproject\.venv
348 .. code-tab:: powershell
351 python -m venv zephyrproject\.venv
357 .. code-tab:: bat
361 .. code-tab:: powershell
376 .. code-block:: bat
382 .. code-block:: bat
392 .. code-block:: bat
394 west zephyr-export
396 #. The Zephyr west extension command, ``west packages`` can be used to install Python
399 .. code-block:: bat
401 west packages pip --install
417 .. group-tab:: Ubuntu
421 .. code-block:: bash
430 See ``west sdk install --help`` for details.
432 .. group-tab:: macOS
436 .. code-block:: bash
445 See ``west sdk install --help`` for details.
447 .. group-tab:: Windows
453 .. code-tab:: bat
458 .. code-tab:: powershell
467 See ``west sdk install --help`` for details.
481 :zephyr:code-sample:`blinky` is compatible with most, but not all, :ref:`boards`. If your board
482 does not meet Blinky's :ref:`blinky-sample-requirements`, then
483 :zephyr:code-sample:`hello_world` is a good alternative.
488 Build the :zephyr:code-sample:`blinky` with :ref:`west build <west-building>`, changing
489 ``<your-board-name>`` appropriately for your board:
493 .. group-tab:: Ubuntu
495 .. code-block:: bash
498 west build -p always -b <your-board-name> samples/basic/blinky
500 .. group-tab:: macOS
502 .. code-block:: bash
505 west build -p always -b <your-board-name> samples/basic/blinky
507 .. group-tab:: Windows
511 .. code-tab:: bat
514 west build -p always -b <your-board-name> samples\basic\blinky
516 .. code-tab:: powershell
519 west build -p always -b <your-board-name> samples\basic\blinky
521 The ``-p always`` option forces a pristine build, and is recommended for new
522 users. Users may also use the ``-p auto`` option, which will use
532 For example to build :zephyr:code-sample:`blinky` for the ``cpuapp`` core on
543 Then flash the sample using :ref:`west flash <west-flashing>`:
545 .. code-block:: shell
551 You may need to install additional :ref:`host tools <flash-debug-host-tools>`
559 Please also see :ref:`setting-udev-rules`.
563 .. figure:: img/ReelBoard-Blinky.png
565 :name: reelboard-blinky
574 * Try other :zephyr:code-sample-category:`samples`
576 * Find out about west's :ref:`flashing and debugging <west-build-flash-debug>`
578 * Check out :ref:`beyond-GSG` for additional setup alternatives and ideas
579 * Discover :ref:`project-resources` for getting help from the Zephyr
644 .. _GitHub issues: https://github.com/zephyrproject-rtos/zephyr/issues