jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 05:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs to reflect new naming for UniFi integration (#20312)

Browse Source 
* Update docs to reflect new naming for UniFi integration

* Update source/_integrations/unifi.markdown

Co-authored-by: Robert Svensson <Kane610@users.noreply.github.com>

* Updates from PR

* Apply suggestions from code review

Co-authored-by: Robert Svensson <Kane610@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Robert Svensson <Kane610@users.noreply.github.com>

* Updates more references to controller

* Another suggestion from PR

Co-authored-by: Robert Svensson <Kane610@users.noreply.github.com>
This commit is contained in:
Christopher Bailey 2021-11-26 17:03:43 -05:00 committed by GitHub
parent bfd0c041c7
commit 5b011a927b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
source/_integrations/unifi.markdown
View File

@ -1,6 +1,6 @@
---
title: Ubiquiti UniFi
description: Instructions on how to configure UniFi integration with UniFi Controller by Ubiquiti.
title: UniFi Network
description: Instructions on how to configure UniFi Network integration with UniFi Network application by Ubiquiti.
ha_category:
- Hub
- Presence Detection
@ -20,7 +20,7 @@ ha_platforms:
- switch
---
[UniFi](https://www.ui.com/software/) by [Ubiquiti Networks, inc.](https://www.ui.com/) is a software that binds gateways, switches and wireless access points together with one graphical front end.
[UniFi Network](https://www.ui.com/software/) by [Ubiquiti Networks, inc.](https://www.ui.com/) is a software that binds gateways, switches and wireless access points together with one graphical front end.
There is currently support for the following device types within Home Assistant:
@ -34,31 +34,31 @@ The user needs administrator privileges in order to control switches.
### Extra configuration of the integration
All configuration options are offered from the front end. Enter what UniFi integration you want to change options on and press the cog wheel. Some advanced options are available when "Advanced Mode" is enabled on your user profile page.
All configuration options are offered from the front end. Enter what UniFi Network integration you want to change options on and press the cog wheel. Some advanced options are available when "Advanced Mode" is enabled on your user profile page.
### Configuring Users
The UniFi controller allows you to create multiple users on it besides the main administrator. If all you want to use is the device tracker then it is recommended that you create a limited user that has `read-only` permissions for the UniFi device tracker. If you want blocking of network access or POE control as well you would need to have 'admin' permissions.
The UniFi Network application allows you to create multiple users on it besides the main administrator. If all you want to use is the device tracker then it is recommended that you create a limited user that has `read-only` permissions for the UniFi Network device tracker. If you want blocking of network access or POE control as well you would need to have 'admin' permissions.
### UniFi OS
For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note the Dream Machine Pro and Cloud Key Gen2 plus updated to UniFi OS needs the port to be 443.
For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note the Dream Machine Pro and Cloud Key Gen2 plus updated to UniFi OS needs the port to be 443.
### Conflicts with MQTT
The UniFi controller can either be a dedicated hardware device (UniFi's cloud key), or as software on any Linux system. If you run the UniFi controller on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT integration as well.
The UniFi Network application can either be a UniFi OS console device (like the Cloud Key), or as software on any Linux system. If you run the UniFi Network application on the same operating system as Home Assistant there may be conflicts in ports if you have the MQTT integration as well.
It is recommended that you run the UniFi controller in a dedicated virtual machine to avoid that situation.
It is recommended that you run the UniFi Network application in a dedicated virtual machine to avoid that situation.
## Presence detection
This platform allows you to detect presence by looking at devices connected to a [Ubiquiti](https://ui.com/) [UniFi](https://unifi-network.ui.com/) controller. By default devices are marked as away 300 seconds after they were last seen.
This platform allows you to detect presence by looking at devices connected to a [Ubiquiti](https://ui.com/) [UniFi Network](https://unifi-network.ui.com/) application. By default devices are marked as away 300 seconds after they were last seen.
### Troubleshooting and Time Synchronization
Presence detection depends on accurate time configuration between Home Assistant and the UniFi controller.
Presence detection depends on accurate time configuration between Home Assistant and the UniFi Network application.
If Home Assistant and the UniFi controller are running on separate machines or VMs ensure that all clocks are synchronized. Failing to have synchronized clocks will lead to Home Assistant failing to mark a device as home.
If Home Assistant and the UniFi Network application are running on separate machines or VMs ensure that all clocks are synchronized. Failing to have synchronized clocks will lead to Home Assistant failing to mark a device as home.
[Related Issue](https://github.com/home-assistant/home-assistant/issues/10507)
@ -70,11 +70,11 @@ Try to get a wireless client to reconnect to the network.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------- |
| `device_id` | No | String representing a device ID related to a UniFi integration. |
| `device_id` | No | String representing a device ID related to a UniFi Network integration. |
### Service unifi.remove_clients
Clean up clients on the UniFi Controller that has only been associated with the controller for a short period of time. The difference between first seen and last seen needs to be less than 15 minutes and the client can not have a fixed IP, hostname or name associated with it.
Clean up clients on the UniFi Network application that has only been associated with the Network application for a short period of time. The difference between first seen and last seen needs to be less than 15 minutes and the client can not have a fixed IP, hostname or name associated with it.
## Switch
@ -104,7 +104,7 @@ Get entities reporting uptime per network client.
## Debugging integration
If you have problems with UniFi or the integration you can add debug prints to the log.
If you have problems with the UniFi Network application or integration you can add debug prints to the log.
```yaml
logger:
@ -115,3 +115,9 @@ logger:
homeassistant.components.device_tracker.unifi: debug
homeassistant.components.switch.unifi: debug
```
## FAQ
### Understanding UniFi Naming (UniFi Network application is the UniFi Controller)
Network management has always been Ubiquiti's main product and so UniFi for a while was always synonymous with their "UniFi Controller" application. However, UniFi has started branching and releasing other apps, like Protect, Talk and Access. As a result, Ubiquiti has started rebranding "UniFi Controller" as the "UniFi Network" application. [This post on the UniFi community](https://community.ui.com/questions/Clarifying-UniFi-Hardware-and-Software-Terminology/2557963a-e79d-4157-a78c-36d3f7b383fb) explains it pretty well. **This main UniFi Integration is _only_ for the UniFi Network application.**