Overview

This node creates a Homekit Camera accessory that can be discovered from and streams to Apple Homekit compatible devices. It can optionally support HomeKit Secure Video (HKSV) to record motion-triggered clips to your Apple Home hub and iCloud.

This node can be used at any point in a PIpeline, but requires a Stream RTSP Node to be present in that PIpeline to function.

Inputs & Outputs

Inputs : 1, Media Format : Raw
Outputs : 1, Media Format : Raw
Output Metadata : None

Properties

Property	Value
`homekit_pin`	Pin to be used to link the camera to Homekit. Must be of the format xxx-xx-xxx Ex. `331-45-211`
`homekit_camera_name`	Camera name as it should appear in Homekit. If not specified, it will be set to the deployment name.
`source_node`	Optional. Stream RTSP Node node name from this PIpeline whose stream to use as the source for the Homekit stream. If not specified, uses the first one it finds.
`lumeo_api_key`	API Key for this Lumeo application that this pipeline is deployed to. Find it here: API
`trigger`	Send a motion detected notification to Homekit when this condition evaluates to true. The trigger expression must be a valid Dot-notation expression that operates on Pipeline Metadata and evaluates to `True` or `False`. See details here. ex. `nodes.annotate_line_counter1.lines.line1.total_objects_crossed_delta > 0` When HomeKit Secure Video is enabled, this same trigger drives the motion events that cause HomeKit to record a clip.
`enable_hksv`	Enable HomeKit Secure Video. When on, the camera advertises recording support so your Apple Home hub can record motion-triggered clips and store them (end-to-end encrypted) in iCloud.
`enable_debug_logs`	Emit verbose per-event diagnostics (HomeKit connections, motion events, stream/recording setup, data-stream frames) to the node logs. Leave off for normal operation; enable only when troubleshooting.

Metadata

Metadata Property	Description
None	None

Homekit Discovery

Once the deployment with this Pipeline is running, on a IOS/Apple device, perform the following steps to discover and link the Camera:

Open the Home App, navigate to "Add Accessory"
Select "More Options" and you should see the Cameras listed there.

HomeKit Secure Video (HKSV)

When enable_hksv is turned on, this node advertises the additional HomeKit services required for Secure Video recording (Camera Operating Mode, Camera Event Recording Management and Data Stream Transport Management) on top of the live stream.

Requirements

An iCloud+ subscription (Secure Video recordings do not count against your iCloud storage).
A home hub that is always on — a HomePod, HomePod mini, or Apple TV 4K. The home hub performs analysis and stores the recordings; the camera only supplies video.
The Lumeo deployment device and the home hub must be on the same local network.

How it works

The Lumeo Pipeline produces an RTSP stream (via a Stream RTSP Node), which this node also uses for live HomeKit viewing.
When HKSV is enabled and you set the camera to Stream & Allow Recording in the Home app, the node continuously re-muxes that RTSP stream into fragmented MP4 and keeps a short rolling prebuffer in memory.
When the trigger condition fires (motion), the Home app opens a HomeKit Data Stream and the node pushes the prebuffered footage followed by live fragments until the event ends. The home hub analyzes and stores the clip.

Setup

Configure a trigger condition that represents motion/activity for your use case (e.g. a line-counter or presence trigger).
Enable enable_hksv.
Add the camera in the Home app as described above.
Open the camera settings in the Home app, choose Recording Options, select the home hub, and set the desired mode (e.g. Stream & Allow Recording and Record: When Motion Is Detected).

Recordings are video-only (the recording pipeline muxes H.264 video only).