UniFi Insights

About

Automatic summary of the README and code of tinkerologie/ha-unifi-insights. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

• Works locally Talks to your devices on your own network. No vendor cloud in between.

• From the Marketplace Installed through the Marketplace, formerly HACS.

• Actively maintained Its author released or pushed a change in the last six months.

Provides

• Lights
• Covers
• Cameras
• Locks
• Alarms
• Media
• Switches
• Sensors
• Presence

Setting it up

Install it from the Marketplace and restart Home Assistant, then add it under Settings, Devices and services.

Texts from the code of tinkerologie/ha-unifi-insights.

Entities

• AlarmsAlarm
• Binary sensorsStatus, Connection, Site-to-Site VPN, Storage Nearly Full, Motion Detection, Person Detection, Vehicle Detection, Animal Detection, Package Detection, and 11 more
• ButtonsDevice restart, PoE Power Cycle, Generate guest voucher, Unlock, Reconnect, Play, Start PTZ patrol, Stop PTZ patrol
• CoversGate
• PresenceLocation
• EventsDoorbell, Smart Detection, Door/Window, Network rule changes, Access result
• ImagesFloor plan, Latest voucher QR code, WiFi QR code
• LocksLock
• MediaSpeaker
• NumbersMicrophone Volume, Brightness Level, Chime Volume, Repeat Times, Voucher duration, Voucher guest limit, Voucher download limit, Voucher upload limit, Voucher data limit
• SelectsHDR Mode, Video Mode, Ringtone, PTZ Preset, Liveview
• SensorsCPU Usage, Memory Usage, Uptime, Uplink Transmit Rate, Uplink Receive Rate, Temperature, Humidity, Battery, and 72 more
• SwitchesStatus Light, High FPS Mode, Allow, Power Cycle, VPN Client, Lockdown, Evacuation
• UpdatesFirmware

Actions

• Refresh DataForce an immediate refresh of UniFi Insights data.Fields: Site ID
• Restart DeviceRestart a UniFi device.Fields: Site ID, Device ID, Entity
• Set Chime Paired DoorbellsChoose which doorbells ring a UniFi Protect chime. The selection replaces the chime's current pairing. Leave Doorbells empty to unpair every doorbell.Fields: Chime ID, Doorbells, Entity, Device
• Suspend SubscriberStop a subscriber's internet service. Requires the "Enable service actions" option to be enabled on the Carrier Fabric integration entry, and an ISP API key with the suspend:service scope.Fields: Reason, Entity, Device
• Resume SubscriberRestore a subscriber's internet service. Requires the "Enable service actions" option to be enabled on the Carrier Fabric integration entry, and an ISP API key with the resume:service scope.Fields: Entity, Device
• Power Cycle PoE PortPower-cycle a PoE-enabled port on a UniFi network device.Fields: Site ID, Device ID, Port Index, Entity
• Reconnect ClientReconnect a connected wireless client to Wi-Fi. Accepts only clients that are currently connected and wireless.Fields: Site ID, Client ID, Entity, Device
• Remove ClientsRemove short-lived, unnamed historical clients from the UniFi Network. Forgets clients that have no name, hostname, or fixed IP and that were seen for 15 minutes or less. If a timestamp is missing, the client is not excluded by the age check. Processes the sites selected in the integration's settings, on consoles that have Network available. Clients with a timestamp that isn't a number are kept. Requires an admin user. Does not remove Home Assistant devices or entities.
• Play Chime RingtoneThis action always raises a not supported error because the official Protect API has no chime playback route.Fields: Chime ID, Ringtone ID, Entity, Device
• Export network rulesReturn a snapshot of the firewall policies, policy-based routes, port forwards, traffic rules, NAT rules and static routes of one console as a versioned document, for comparison, versioning and manual recovery. It is not a complete console backup: the networks, zones, traffic matching lists, groups and VPN definitions that rules refer to are not included, and there is no import. The rules are read from the console when you run the action. Only a rule type with status ok is complete. Failed means the answer could not be read, was not JSON, was incomplete or held a record that could not be parsed. Unsupported means the console refused the request, or the site has no classic name for the five rule types other than firewall policies. Requires an admin user. The action only returns data; it does not write a file.Fields: Site ID, Console, Rule types, Redact sensitive values
• Set Access user PINAssign a PIN to a UniFi Access user. The PIN must be digits only; the console checks its length and returns a rejection if it does not accept the value. Requires an admin user.Fields: User ID, PIN, Console
• Remove Access user PINRemove the PIN assigned to a UniFi Access user. Requires an admin user.Fields: User ID, Console
• Set Access user statusSet a UniFi Access user account to ACTIVE or DEACTIVATED. This controls the whole account, so a deactivated user loses access through every credential. Requires an admin user.Fields: User ID, Status, Console

Troubleshooting

• DiagnosticsDownloads a diagnostics file to attach to a bug report.

From the README