PTZ

Use this action to pan, tilt, or zoom an ONVIF camera that supports PTZ. You can also move the camera to a saved preset position.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To move a camera from an automation or a script:

  1. Go to Settings > Automations & scenes.
  2. Open an existing automation or script, or select Create automation > Create new automation.
  3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
  4. In the Then do section, select Add action.
  5. Select what you want to control. Under By target (see Targets), select the ONVIF camera you want to move.
  6. From the actions shown for that target, select PTZ.
  7. Fill in the options you want to use.
  8. Select Save.

Options in the UI

Pan

The pan direction. One of: LEFT or RIGHT.

Tilt

The tilt direction. One of: UP or DOWN.

Zoom

The zoom direction. One of: ZOOM_IN or ZOOM_OUT.

Distance

The distance coefficient. Sets how much the camera moves in one request, from 0 to 1.

Speed

The speed coefficient. Sets how fast the camera moves, from 0 to 1.

Move Mode

The move mode. One of: ContinuousMove, RelativeMove, AbsoluteMove, GotoPreset, or Stop.

Continuous duration

For ContinuousMove, the delay in seconds before the move stops.

Preset

The PTZ preset profile token to move to. Used with the GotoPreset move mode.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as onvif.ptz. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: onvif.ptz
target:
  entity_id: camera.front_door
data:
  pan: RIGHT
  tilt: UP

This pans the camera right and tilts it up.

Options in YAML

pan string

The pan direction. One of: LEFT or RIGHT.

tilt string

The tilt direction. One of: UP or DOWN.

zoom string

The zoom direction. One of: ZOOM_IN or ZOOM_OUT.

distance float

The distance coefficient. Sets how much the camera moves in one request, from 0 to 1.

speed float

The speed coefficient. Sets how fast the camera moves, from 0 to 1.

move_mode string

The move mode. One of: ContinuousMove, RelativeMove, AbsoluteMove, GotoPreset, or Stop.

continuous_duration float

For the ContinuousMove mode, the delay in seconds before the move stops.

preset string

The PTZ preset profile token to move to. Used with the GotoPreset move mode.

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching camera entity behind that target.

  • Entity: one specific camera entity, such as camera.living_room.
  • Device: every camera entity that belongs to a device.
  • Area: every camera entity in a room or area.
  • Floor: every camera entity on a floor.
  • Label: every camera entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

  • Your camera must support PTZ for this action to have any effect.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.