ndi-ptz

This is a CLI to control an NDI-enabled PTZ camera with a joystick.

Installation

uv tool install ndi-ptz

# or
pip install ndi-ptz

You also need to install the NDI Runtime, unless you have the NDI Tools or the NDI SDK installed

• Windows: http://ndi.link/NDIRedistV6
• MacOS: http://ndi.link/NDIRedistV6Apple
• Linux: https://downloads.ndi.tv/SDK/NDI_SDK_Linux/Install_NDI_SDK_v6_Linux.tar.gz
  • see also https://github.com/DistroAV/DistroAV/blob/master/CI/libndi-get.sh

For further options, like choco or brew, consult the DistroAV wiki.

Quick-Start

$ ndi-ptz control

Or pre-defined a source and joystick:

$ ndi-ptz list-sources
Looking for NDI sources in the next 5 seconds
TAIL_AIR_006666 (OBSBOT)

$ ndi-ptz list-joysticks
Looking for joysticks in the next 5 seconds
Nintendo Switch Pro Controller (0)

$ ndi-ptz control --source-name "TAIL_AIR_006666 (OBSBOT)" --joystick-instance 0

Supported Joysticks

Currently only the following joysticks are supported:

• Nintendo Switch Pro Controller
• Xbox Series X Controller
• Xbox 360 Controller
• PlayStation 4 Controller
• PlayStation 5 Controller

Nintendo Controller

Only the Nintendo Switch Pro Controller was tested.

• You must hold L and R constantly to control the PTZ.
• Use the left stick to control pan (left/right) and tilt (up/down).
• Use the right stick to control the zoom (up/down).
• Press the right stick to return the camera to the home position.
• Hold the A button to trigger the autofocus.

Xbox Controller

Only the Xbox Series X Controller was tested. On Mac, it only works when connected via Bluetooth.

• You must hold L and R constantly to control the PTZ.
• Use the left stick to control pan (left/right) and tilt (up/down).
• Use the right stick to control the zoom (up/down).
• Press the right stick to return the camera to the home position.
• Hold the B button to trigger the autofocus.

PlayStation Controller

PlayStation 4 and 5 controllers were tested.

• You must hold L and R constantly to control the PTZ.
• Use the left stick to control pan (left/right) and tilt (up/down).
• Use the right stick to control the zoom (up/down).
• Press the right stick to return the camera to the home position.
• Hold the O button to trigger the autofocus.

Development

This project is managed with UV.

Build & Publish

# edit the project version in pyproject.toml
uv sync
git commit -m "Prepare 0.1.5" .
git tag '0.1.5'
rm -rf dist
uv build
uv publish
git push --tags
git push

Legal

This code is provided under the terms and permissions granted by the MIT license.

NDI® is a registered trademark of Vizrt NDI AB.