# MacOS Development Environment
The following instructions set up a PX4 development environment for macOS. This environment can be used to build PX4 for:
# Video Guide
# Base Setup
The "base" macOS setup installs the tools needed for building firmware, and includes the common tools that will be needed for installing/using the simulators.
# Environment Setup
Apple M1 Macbook users!
If you have an Apple M1 Macbook, make sure to run the terminal as x86 by setting up an x86 terminal:
- Locate the Terminal application within the Utilities folder (Finder > Go menu > Utilities)
- Select Terminal.app and right-click on it, then choose Duplicate.
- Rename the duplicated Terminal app, e.g. to x86 Terminal
- Now select the renamed x86 Terminal app and right-click and choose *Get Info
- Check the box for Open using Rosetta, then close the window
- Run the x86 Terminal as usual, which will fully support the current PX4 toolchain
First set up the environment
Enable more open files by appending the following line to the
~/.zshenvfile (creating it if necessary):
echo ulimit -S -n 2048 >> ~/.zshenv
If you don't do this, the build toolchain may report the error:
"LD: too many open files"
Enforce Python 3 by appending the following lines to
# Point pip3 to MacOS system python 3 pip alias pip3=/usr/bin/pip3
# Common Tools
To setup the environment to be able to build for Pixhawk/NuttX hardware (and install the common tools for using simulators):
Install Homebrew by following these installation instructions (opens new window).
Run these commands in your shell to install the common tools:
brew tap PX4/px4 brew install px4-dev
Install the required Python packages:
# install required packages using pip3 python3 -m pip install --user pyserial empty toml numpy pandas jinja2 pyyaml pyros-genmsg packaging kconfiglib future jsonschema # if this fails with a permissions error, your Python install is in a system path - use this command instead: sudo -H python3 -m pip install --user pyserial empty toml numpy pandas jinja2 pyyaml pyros-genmsg packaging kconfiglib future jsonschema
# Gazebo Classic Simulation
To setup the environment for Gazebo Classic simulation:
Run the following commands in your shell:
brew unlink tbb sed -i.bak '/disable! date:/s/^/ /; /disable! date:/s/./#/3' $(brew --prefix)/Library/Taps/homebrew/homebrew-core/Formulaemail@example.com brew install tbb@2020 brew link tbb@2020
September 2021: The commands above are a workaround to this bug: PX4-Autopilot#17644 (opens new window). They can be removed once it is fixed (along with this note).
To install SITL simulation with Gazebo Classic:
brew install --cask temurin brew install --cask xquartz brew install px4-sim-gazebo
Run the macOS setup script:
PX4-Autopilot/Tools/setup/macos.shThe easiest way to do this is to clone the PX4 source, and then run the script from the directory, as shown:
git clone https://github.com/PX4/PX4-Autopilot.git --recursive cd PX4-Autopilot/Tools/setup sh macos.sh
# jMAVSim Simulation
To setup the environment for jMAVSim simulation:
brew install --cask temurin
brew install px4-sim-jmavsim
PX4 v1.11 and beyond require at least JDK 15 for jMAVSim simulation.
For earlier versions, macOS users might see the error
Exception in thread "main" java.lang.UnsupportedClassVersionError:. You can find the fix in the jMAVSim with SITL > Troubleshooting).
# Next Steps
Once you have finished setting up the command-line toolchain:
Install VSCode (if you prefer using an IDE to the command line).
Install the QGroundControl Daily Build (opens new window)
The daily build includes development tools that are hidden in release builds. It may also provide access to new PX4 features that are not yet supported in release builds.
Continue to the build instructions.