diff --git a/unifi/README.md b/unifi/README.md index c1ddc04e..28620f20 100644 --- a/unifi/README.md +++ b/unifi/README.md @@ -1,11 +1,15 @@ # UniFi -This plugin adds support to connect nymea to a UniFi network controller and monitor devices for presence. +This plugin adds support to connect nymea to a UniFi network controller and monitor devices for presence.
+UniFi distinguishs between Controller running on a UniFi Console and Controller running on a Windows, macOS or Linux machine. ## Usage -In order to monitor network devices via a UniFi controller, it is required to configure the UniFi controller. -The IP, as well as username and password for the UniFi controller must be provided. +In order to monitor network devices via a UniFi controller, it is required to configure the UniFi controller.
+The IP, as well as username and password for the UniFi controller must be provided. The port is optional.
+For Controller running on a UniFi console the port must be 443. Network controller running on Windows, macOS or Linux machines
+usually use port 8443. This is also the default value if empty.
+The login-user must have a local access only for the controller, a user with cloud access will not work. Once the controller is added to the system, additional Wi-Fi devices may be added by starting a discovery of UniFi clients. After a client is addded, it will appear as presence sensor in the system.