Home Assistant integration (HACS)

Bring your Yunkan cameras, detection and recordings into Home Assistant with the official custom integration — installed in one click via HACS, no MQTT broker required.

Yunkan now ships an official Home Assistant custom integration. It is a thin client that talks to your Yunkan server over its regular API and maps it onto native Home Assistant entities, a media browser and services — all recording, detection and account logic stays on the server.

Opens this repository in your Home Assistant's HACS as a custom repository.

What you get

Cameras with native WebRTC (low-latency, HLS fallback) and JPEG snapshots — picture-glance cards, area dashboards, HomeKit export and camera.snapshot.
Detection sensors per camera — person, vehicle, animal, package, face, fall, baby-cry and motion — carrying the recognised name / licence plate.
Object-count sensors plus recognised face / plate sensors.
Switches — AI detection, recording, per-feature detection toggles, PTZ auto-tracking — plus server-wide detection switches on the hub.
Device-page controls — refresh-snapshot and PTZ direction buttons, a PTZ preset dropdown and a voice-broadcast field.
Device triggers and actions for automations, plus a ready-made notification blueprint.
Media browser for recordings, events and snapshots, proxied through Home Assistant's own authentication.

Requirements

Home Assistant 2024.11 or newer (for native WebRTC cameras).
A reachable Yunkan server — use its main entry address (the nginx entry, usually port 23406).
A Yunkan account. An admin account is required for PTZ, the detection switches and voice broadcast; viewing works with any account.

Install via HACS

1
Open in HACS
Click the Open in HACS button above (or, in HACS, open the three-dot menu → Custom repositories and add the repository URL with category *Integration*).
2
Install and restart
Search for Yunkan in HACS, install it, then restart Home Assistant.
3
Add the integration
Go to Settings → Devices & Services → Add Integration → Yunkan and enter your server URL, username and password.

Installed as a custom repository

Yunkan is not in the default HACS store yet (a submission is in review), so it installs as a custom repository — the button above sets that up for you. Once it's in the default store you'll be able to search for it directly.

Free tier vs Pro

Cameras, snapshots, events, sensors, the media browser and PTZ work on any Yunkan server. AI detection and voice broadcast are Pro features; on a free-tier server those actions surface an upgrade notice instead of failing silently.

Works alongside MQTT discovery

If you also use Yunkan's MQTT discovery, both paths coexist with distinct entity IDs. This integration is the richer, Pro-oriented alternative and does not require an MQTT broker.