Requirements

Bridle supports Linux for development and in theory macOS and Windows, but these have not been tested yet.

Supported operating systems

The following table shows the operating system versions that support the Bridle development environment:

LinuxmacOSWindows

Operating System	x86	x64	ARM	ARM64	PPC64LE	RISV64	S390X
Ubuntu 24.04 LTS	Not applicable	Tier 1	Not supported	Tier 3	Not supported	Not supported	Not supported
Ubuntu 22.04 LTS	Not applicable	Tier 2	Not supported	Tier 3	Not supported	Not supported	Not supported
Ubuntu 20.04 LTS	Not applicable	Tier 2	Not supported	Tier 2	Not supported	Not supported	Not supported

The table uses the following Tier # definitions to categorize the level of operating system support:

Tier 1

The Bridle development environment will always work. The automated build and automated testing ensure that the Bridle development environment build and successfully complete tests after each change.

Tier 2

The Bridle development environment will always build. The automated build ensures that the Bridle development environment build successfully after each change. There is no guarantee that a build will work because the automation tests do not always run.

Tier 3

The Bridle development environment are supported by design but not built or tested after each change. Therefore, the application may or may not work.

Not supported

The Bridle development environment do not work, but it may be supported in the future.

Not applicable

The specified architecture is not supported for the respective operating system.

Note

The Bridle development environment are not supported by the older versions of the operating system.

Required tools

The following table shows the tools that are required for working with Bridle v4.2.99. It lists the minimum version that is required and the version that is installed when using the System Install Manager as described in Installing Bridle through … t.b.d. (TBD) Desktop Installer.

LinuxmacOSWindows

Tool / Suggestion	Minimum version	Tested version
Git Git (Ubuntu DPKG)		1:2.43.0-1ubuntu7.3
Python 3 Python 3 (Ubuntu DPKG)	3.12	3.12.3-0ubuntu2
Zephyr RTOS meta tool west (PyPA)	0.14.0	1.4.0
CMake CMake (Ubuntu DPKG)	3.20.5	3.28.3-1build7
Ninja Ninja (Ubuntu DPKG)	1.8.2	1.11.1-2
Device tree compiler Device tree compiler (Ubuntu DPKG)	1.4.6	1.7.0-2build1
OpenOCD OpenOCD (Ubuntu DPKG)	0.11	0.12.0-1build2
DFU Utilities DFU Utilities (Ubuntu DPKG)		0.11-1
GNU gperf GNU gperf (Ubuntu DPKG)	3.1	3.1-1build1
Tools for documentation
Doxygen Doxygen (Ubuntu DPKG)	1.9.2	1.9.8+ds-2build5
Graphviz dot Graphviz (Ubuntu DPKG)	2.42	2.42.2-9ubuntu0.1
MscGen MscGen (Ubuntu DPKG)	0.20	0.20-15
Ccache Ccache (Ubuntu DPKG)		4.9.1-1
SDK suites for development
Zephyr SDK	0.17.0	0.17.2
Arm GNU Toolchain	11.2-2022.02	14.2.rel1-202411
GNU Arm Embedded Toolchain	10-2020-q4-major	10.3-2021.10
STM32CubeCLT (GNU tools for STM32)	1.11.1 (10.3.rel1)	1.18.0 (13.3.rel1-202409)
MCUXpresso IDE (Arm GNU Toolchain)	11.9.0 (12.3.rel1)	24.9.25 (13.2.rel1-202310)

Required Python dependencies

The following table shows the Python packages that are required for working with Bridle v4.2.99. If no version is specified, the default version provided with pip is recommended. If a version is specified, it is important that the installed version matches the required version. See Installing additional Python dependencies for instructions on how to install the Python dependencies.

Building and running applications, samples, and tests

Package	Version	Description
PyYAML	>=6.0	YAML parser and emitter for Python
ecdsa	>=0.19	easy-to-use Python implementation of elliptic curve algorithm (ECC, ECDSA, EdDSA, ECDH)
intelhex	>=2.3	read, write, create and manipulate data from Intel HEX file
pyelftools	>=0.32	analyzing ELF files and DWARF debugging information
pykitinfo	>=1.4	provide information from Microchip development kits connected via USB
pylint	>=3.3	static code analyser for Python 2 or 3 without actually running it
pymcuprog	>=3.19	programming various Microchip MCU devices using Microchip CMSIS-DAP based debuggers
pyocd	<0.37,>=0.36	programming and debugging Arm Cortex-M MCU with a wide range of debug probes
pyserial	>=3.5	cross-platform (Windows, OSX, Linux, BSD) access to the serial port
pytest	>=8.4	simple powerful testing framework for Python
regex	>=2025.9	RegEx with additional functionality; backwards-compatible to the standard Python re module
west	>=0.14.0,<1.5.0	The Zephyr RTOS Project meta-tool, a swiss-army knife command line tool
windows-curses (only Windows)		wide character extension to the standard Python curses module on Windows

Building documentation

Package	Version	Description
Pillow	~=11.3	Python Imaging Library (former and successor of PIL)
Pygments	~=2.19,!=2.19.0	syntax highlighting package for HTML, LaTeX, RTF, SVG, images by Pillow (PIL) and ANSI sequences
Sphinx	~=8.2,<8.3	documentation generator based on reStructuredText (RST) files
docutils	>=0.21,<0.22	modular system for processing RST documentation, backend of Sphinx
doxmlparser	~=1.14	parses the XML output produced by Doxygen
imagesize	>=1.4	parses image files’ header and return image size
sphinx-autobuild	~=2025.8	rebuilding Sphinx documentation on changes, with hot reloading in browsers
sphinx-copybutton	~=0.5	adds a copy button to code blocks
sphinx-csv-filter	~=0.4	adds CSV row filtering options to the csv-table directive
sphinx-filter-tabs	~=1.2	creating accessible, filterable content tabs
sphinx-notfound-page	~=1.1	creates a custom 404 page with absolute URLs hardcoded
sphinx-sitemap	~=2.8	generate multiversion and multilanguage sitemaps.org compliant sitemaps
sphinx-tabs	~=3.4	creates tabbed content
sphinx-togglebutton	~=0.3	enables a toggle button for sections
sphinx-tsn-theme	~=2024.11	Sphinx theme for TiaC Systems Network (TSN) documentation
sphinxcontrib-mscgen	~=0.6	allows embedded mscgen-formatted Message Sequence Chart (MSC) graphs
sphinxcontrib-programoutput	~=0.18	literally insert output of arbitrary commands into documents
sphinxcontrib-svg2pdfconverter	~=1.3	SVG images to PDF converter for builder does not support SVG

Utilities that assist documentation writing

Package	Version	Description
sphobjinv	~=2.3	Sphinx objects.inv files manipulator and inspector