Frigate icon

Frigate

Control Frigate over its real-time /ws API

Set Camera Enabled

AI-generated

Summary

Publishes an ON/OFF message over the Frigate /ws API to enable or disable the entire camera processing pipeline for a specified camera.

Inputs

  • camera (required) — The camera name as configured in Frigate.
  • value (required) — Whether to turn the feature on or off (ON or OFF).
  • awaitState — Whether to keep the socket open after publishing and wait for the matching /state read-back to confirm the new value.
  • awaitTimeoutMs — How long to wait for the /state read-back before giving up (0-600000 ms).

Output shape

No body — success/failure only. Returns metadata about the operation if awaitState is enabled.

When awaitState is true, returns an object containing operation, topic, payload, published, received, confirmed, stateTopic, and stateValue.

Examples

Example 1: Enable a camera

Operation: Set Camera Enabled, Camera: front_door, Value: ON

Example 2: Disable a camera and wait for confirmation

Operation: Set Camera Enabled, Camera: back_yard, Value: OFF, Await State Confirmation: true

Links

Discussion