Frigate icon

Frigate

Control Frigate over its real-time /ws API

Set Object Mask

AI-generated

Summary

Enable or disable a named object mask for a Frigate camera by publishing the selected value to that mask’s /set topic.

Inputs

  • Camera (required) — Camera name as configured in Frigate.
  • Value (required) — Choose ON or OFF to enable or disable the mask; defaults to ON.
  • Mask Name (required) — Name of the configured object mask.
  • Await State Confirmation — When enabled, wait for a read-back on the mask’s /state topic after publishing; defaults to false.
  • Confirmation Timeout (Ms) — When waiting for confirmation, how long to wait before returning without a read-back; defaults to 5000 ms and is limited to 0–600000 ms.

Output shape

One n8n item per input item, with operation, topic, payload, and published fields; when state confirmation is enabled, also includes received, confirmed, stateTopic, and stateValue.

Publishes to frigate/<camera>/object_mask/<mask_name>/set. Confirmation listens for the corresponding /state topic. If no matching state message arrives before the timeout, received and confirmed are false and stateValue is null. Errors fail the operation unless the node is configured to continue on fail.

Links

Discussion