Connect your own Home Assistant so your team can see and control the devices it manages. The platform reaches your instance over the internet by its domain name, so it must answer over HTTPS.
Before you start
- You need the Manage IoT Connections right.
- Home Assistant must be version 2024.1 or later.
- Home Assistant must be reachable from outside by a domain name (for example
https://home.example.com, or your Home Assistant Cloud address). IP addresses and plain HTTP are not accepted, and only ports 443 and 8123 are allowed. - New Home Assistant OS installations answer on port 80 without HTTPS. Set up HTTPS first, for example with Home Assistant Cloud.
- In Home Assistant, create a user for this connection under Settings → People. Commands sent from here are recorded under that user.
Connect it
- Go to Settings → Devices (IoT) → Connections and choose Add connection.
- In Add a connection, choose Home Assistant (under Smart home).
- In Name this connection, enter the name people will see.
- Enter your Home Assistant address.
- Choose Sign in. Home Assistant opens in the same tab. Sign in as the user you created and approve. You come back to the Connections tab.
If you would rather not sign in, choose Use an access token instead. Create a long-lived access token on that user's profile in Home Assistant (Security tab), paste it into Long-lived access token (optional) and choose Test and link. If you link this way, delete the token in Home Assistant too when you remove the connection.
Result
After a sign-in, the Connections tab says Connected. Looking for devices…, then how many devices it found. After a token link, the form says it is connected and how many devices it found; choose Done. Devices are kept up to date live over a constant connection to your instance.
To place devices by their Home Assistant areas, map the areas under Vendor rooms on Settings → Devices (IoT) → Sites and spaces; see How to Set Up Sites and Spaces.
If it doesn't work
- Use the instance's domain name, not an IP address. Enter the domain name.
- The address must start with https://. Set up HTTPS and use the secure address.
- Only port 443 or 8123 is allowed. Use one of those ports.
- That address does not point to the public internet. The address only works inside your network. Use the address you reach from outside.
- A message says the version is too old: update Home Assistant to 2024.1 or later, then try again.
- Other messages are explained in Fixing a Connection Problem.
Related articles
Other guides that answer questions close to this one.
How to Relink a Connection
Relink a connection when it says Needs a new sign-in. Relinking keeps the connection, its devices, their places, your access and your shares. Removing it and adding it again does not. Before you start You need the…
What a Connection's Health Means
Every connection has a health that tells you whether its devices can be trusted right now. It is checked when you link or sign in again, once a day, when a connection is turned back on, and whenever you choose Check…
Fixing a Connection Problem
Each connection card shows its health and, after a failure, a line that starts "Last problem", with the time and the reason. Checks lists the recent checks with what each one found. Find your reason below. Before you…
How to Set Up Sites and Spaces
A site is a place, such as an office, a shop or a building. Inside a site you describe its spaces: buildings, floors, rooms, areas and vehicle bays. Spaces make devices easy to find, and they let you give access by…
How to Connect Samsara
Follow Samsara vehicles and their environmental and door sensors. The connection reads fleets; it does not control vehicles, and it does not show dash-camera media. Before you start You need the Manage IoT Connections…