Add optional API and avatars for use by other tools

.node-version

@@ -1 +1 @@
-19.7.0
+20.2.0

README.md

@@ -33,6 +33,57 @@ In addition to sensors for whether a specific device is in a specific room, sens
 
 PS. To see the smartphones on your network in your macOS menu bar as well, check out [XBar + UniFi = Who's Home?](https://github.com/DouweM/xbar-whos-home-unifi).
 
+### Web Server
+
+This plugin can expose an API to allow other services on your network to learn what devices (and people) are connected. Currently, the only endpoint is `http://localhost:<port>/clients`.
+
+The Web Server can be enabled in Settings.
+You can also assign an avatar (using a Gravatar email or image URL) to each device owner. The avatar is not shown in the Home app, but its URL is exposed in the API for use by other services.
+
+<details>
+<summary>Example JSON</summary>
+
+```json
+[
+  {
+    "display_name": "Douwe",
+    "type": "smartphone",
+    "room": "Living",
+    "image_url": "https://s.gravatar.com/avatar/2053c25524bfc5fe833861f628896f87",
+    "owner": "Douwe",
+    "name": "Douwe’s iPhone",
+    "hostname": "",
+    "mac": "...",
+    "ip": "192.168.1.214",
+    "connected": true,
+    "wired": false,
+    "wifi_ssid": "...",
+    "room_mac": "...",
+    "fingerprint": {
+      "dev_type_id": "44",
+      "family_id": "9",
+      "name": "Apple iPhone 14 Pro",
+      "os_class_id": "15",
+      "os_name_id": "24",
+      "vendor_id": "320",
+      "id": 4841,
+      "image_url": "https://static.ubnt.com/fingerprint/0/4841_101x101.png",
+      "family": "Smartphone",
+      "type": "Handheld",
+      "type_id": "44",
+      "vendor": "Apple, Inc.",
+      "os_class": "Apple iOS",
+      "os_name": "Apple iOS"
+    },
+    "avatar_url": "https://s.gravatar.com/avatar/2053c25524bfc5fe833861f628896f87",
+    "guest": false,
+    "show_as_owner": true,
+    "raw": {...} # Raw client info from UniFi API
+  }
+]
+```
+</details>
+
 ## Screenshot
 
 <table>
@@ -169,6 +220,22 @@ Alternatively, add `homebridge-unifi-occupancy` to your Homebridge `package.json
           "homeCatchallAccessory": false,
           "lazy": true
         }
+      ],
+      "server": {
+        "enabled": false,
+        "port": 8582,
+        "username": "",
+        "password": "",
+      },
+      "avatars": [
+        {
+          "owner": "Douwe",
+          "identifier": "[email protected]"
+        },
+        {
+          "owner": "Gaby",
+          "identifier": "https://em-content.zobj.net/thumbs/240/apple/354/woman_medium-skin-tone_1f469-1f3fd_1f3fd.png"
+        }
       ]
     }
   ]

config.schema.json

@@ -398,6 +398,53 @@
             }
           }
         }
+      },
+      "server": {
+        "title": "Web Server",
+        "description": "This plugin can expose an API to allow other services on your network to learn what devices (and people) are connected. Currently, the only endpoint is `http://localhost:<port>/clients`.",
+        "type": "object",
+        "properties": {
+          "enabled": {
+            "title": "Enabled",
+            "type": "boolean",
+            "default": false
+          },
+          "port": {
+            "title": "Port",
+            "type": "integer",
+            "default": 8582
+          },
+          "username": {
+            "title": "Username",
+            "description": "Enter a username and password to enable HTTP Basic Authentication.",
+            "type": "string"
+          },
+          "password": {
+            "title": "Password",
+            "type": "string"
+          }
+        }
+      },
+      "avatars": {
+        "title": "Avatars",
+        "description": "You can assign an avatar to each device owner. The avatar is not shown in the Home app, but its URL is exposed in the API for use by other services. The owner's name is derived from the device (host)name or the alias configured in the UniFi Network UI. For example, `Douwe` for any of `Douwe's [device]` (English), `[device] de Douwe` (Spanish), and `[device] van Douwe` (Dutch).",
+        "type": "array",
+        "items": {
+          "title": "Avatar",
+          "type": "object",
+          "properties": {
+            "owner": {
+              "title": "Owner",
+              "type": "string",
+              "required": true
+            },
+            "identifier": {
+              "title": "Gravatar email or image URL",
+              "type": "string",
+              "required": true
+            }
+          }
+        }
       }
     }
   },
@@ -621,6 +668,39 @@
           ]
         }
       ]
+    },
+    {
+      "ref": "server",
+      "type": "fieldset",
+      "title": "Web Server",
+      "expandable": true,
+      "items": [
+        {
+          "key": "server",
+          "type": "object",
+          "notitle": true,
+          "items": [
+            "server.enabled",
+            "server.port",
+            "server.username",
+            "server.password"
+          ]
+        },
+        {
+          "ref": "avatars",
+          "type": "fieldset",
+          "title": "Avatars",
+          "expandable": true,
+          "items": [
+            {
+              "key": "avatars",
+              "type": "array",
+              "notitle": true,
+              "items": ["avatars[].owner", "avatars[].identifier"]
+            }
+          ]
+        }
+      ]
     }
   ]
 }