You'll need to set up a development environment if you want to develop a new feature or component for Home Assistant. Read on to learn how to set up.
Developing with Visual Studio Code + devcontainer
The easiest way to get started with development is to use Visual Studio Code with devcontainers. This approach will create a preconfigured development environment with all the tools you need. This approach is enabled for all Home Assistant repositories.
- Visual Studio code
- Remote - Containers (VSC Extension)
- Fork the repository.
- Clone the repository to your computer.
- Open the repository using Visual Studio code.
When you open this repository with Visual Studio code you are asked to "Reopen in Container", this will start the build of the container.
If you don't see this notification, open the command palette and select
Remote-Containers: Reopen Folder in Container.
The devcontainter comes with some useful tasks to help you with development, you can start these tasks by opening the command palette and select
Tasks: Run Task then select the task you want to run.
When a task is currently running (like
Preview for the docs), it can be restarted by opening the command palette and selecting
Tasks: Restart Running Task, then select the task you want to restart.
Preparing Your environment
It is also possible to set up a more traditional development environment. See the section for your operating system. Make sure your Python version is 3.7 or later.
Developing on Linux
Install the core dependencies.
In order to run
script/setup below you will need some more dependencies.
Different distributions have different package installation mechanisms and sometimes packages names as well. For example CentOS would use:
sudo yum install epel-release && sudo yum install python36 python36-devel mysql-devel gcc
Additional dependencies exist if you plan to perform Frontend Development, please read the Frontend section to learn more.
Developing on Windows
Since Home Assistant is mainly designed and developed on Linux distributions, on Windows 10 you can setup a Linux subsystem.
Open Powershell as an Administrator and run
From Windows Store install Ubuntu.
For those already running Ubuntu 18.04 on WSL
If you are running Ubuntu 18.04 on Windows Subsystem for Linux some additional steps are needed to install the latest FFmpeg version.
When the Linux subsystem is set up, perform install as for Linux.
Hint: Git is included in Linux subsytem.
When invoking your installation (see below), make sure to specify a folder for configuration which is accessible from Windows.
You may find that you cannot open the development instance via http://localhost:8123 when using WSL. Instead, within a WSL terminal, find the
inet address of the
eth0 adaptor by running
ip addr show eth0. Then use this address, excluding the CIDR block, to access the development instance, i.e. if your
inet is listed as
172.20.37.6/20, use http://172.20.37.6:8123.
Developing on macOS
Install Homebrew, then use that to install Python 3:
Then install ffmpeg:
Setup Local Repository
Visit the Home Assistant Core repository and click Fork. Once forked, setup your local copy of the source using the commands:
Windows users should be sure to clone to a path that inside the WSL (ex: ~/).
core.git should be replaced by the name of your fork (default being
core.git). If unsure check your GitHub repository.
Setting Up Virtual Environment
To isolate your environment from the rest of the system, set up a
venv. Within the
core directory, create and activate your virtual environment.
Install the requirements with a provided script named
Invoke your installation, adjusting the configuration if required.
By default logging in Home Assistant is tuned for operating in production (set to INFO by default, with some modules set to even less verbose logging levels).
You can use the logger component to adjust logging to DEBUG to see even more details about what is going on: