Add Stream Deck and Companion guide screenshots

[jochenwezel]

Summary

The documentation now includes initial text guides for Stream Deck and Bitfocus Companion usage. Add real screenshots later to make the guides easier to follow.

Screenshot targets

Stream Deck guide:

• command/run action configuration
• program path pointing to PTZControlConsole.exe
• arguments field with a preset command
• finished button grid with camera actions
• optional DirectShow rename example with warning context

Bitfocus Companion guide:

• module/connection configuration when the module exists
• console path setting
• camera dropdown with device name, slot, alias, and device path metadata
• button action configured for
  estore-preset
• button action configured for zoom or movement
• Companion button grid with camera preset buttons

Notes

Use real screenshots from the target tools instead of mockups where possible. Keep captions concise and make sure screenshots match the current CLI syntax.

[jochenwezel]

On-site Companion page import checklist

Use this note as the compact on-site checklist for importing the prepared PTZControlConsole page into the current Bitfocus Companion version.

Files / links

Repository file:

• docs/assets/PTZControlConsole-companion-page.companionconfig
• Direct GitHub link: https://github.com/jochenwezel/PTZControl/blob/main/docs/assets/PTZControlConsole-companion-page.companionconfig

Related guide:

• https://github.com/jochenwezel/PTZControl/blob/main/docs/bitfocus-companion.md

What the page contains

The prepared Companion page uses Companion's built-in action:

• System: Run shell command (local)
• internal action model: internal / exec

The page is designed for a 5 x 3 button layout.

Layout:

Speaker   Band     Audience   Full stage   Piano
Zoom+     Pan <    Tilt ^     Pan >
Zoom-              Tilt v                 Back

Buttons included:

• restore preset 1..5
• restore home movement via Back
• zoom in / zoom out
• pan left / pan right
• tilt up / tilt down

The buttons use robust text labels instead of external image icons, so the page can be imported without an image-library dependency.

Assumptions inside the imported buttons

The prepared commands assume this Windows install folder:

C:\Tools\PTZControlConsole\PTZControlConsole.exe

The prepared commands select the camera by name:

--camera "PTZ Pro 2"

If the console package is extracted elsewhere, or if the camera has another name, edit the imported button actions accordingly.

Recommended preparation before opening Companion

1. Download/extract the latest Windows console release package.
2. Put it into this folder if possible:

C:\Tools\PTZControlConsole

3. Verify in PowerShell:

cd C:\Tools\PTZControlConsole
.\PTZControlConsole.exe list-devices
.\PTZControlConsole.exe cam-device-info --camera "PTZ Pro 2"

4. If the camera name differs, note the exact usable selector. Possible selector styles:

--camera "NamePart"
--device-path "DevicePath"
--slot 1

Use exactly one selector per command.

Import into Companion

1. Open Companion.
2. Go to the import/export area or the page import workflow.
3. Import this file:

PTZControlConsole-companion-page.companionconfig

4. Import it as a page, preferably into an unused page.
5. After import, open a few buttons and check the internal shell command action.
6. Adjust the executable path and camera selector if needed.

First button tests in Companion

Start with low-risk actions:

restore-home --target move --camera "PTZ Pro 2"
zoom-relative 10 --mode percent --camera "PTZ Pro 2"
zoom-relative -10 --mode percent --camera "PTZ Pro 2"

Then test visible pan/tilt movement:

move-relative --mode percent --pan 10 --camera "PTZ Pro 2"
move-relative --mode percent --pan -10 --camera "PTZ Pro 2"
move-relative --mode percent --tilt 10 --camera "PTZ Pro 2"
move-relative --mode percent --tilt -10 --camera "PTZ Pro 2"

Finally test presets if they are already known/saved:

restore-preset 1 --camera "PTZ Pro 2"
restore-preset 2 --camera "PTZ Pro 2"

Fallback if page import fails

If Companion rejects the .companionconfig file, manually create buttons using Companion's System: Run shell command (local) action.

Example command:

"C:\Tools\PTZControlConsole\PTZControlConsole.exe" restore-preset 1 --camera "PTZ Pro 2"

Working directory:

C:\Tools\PTZControlConsole

Timeout:

5000

What to capture for follow-up

Please capture screenshots of:

• Companion import result or import error
• one imported button action showing the shell command
• the Companion button grid after import
• any command output / Companion log entry if a button does not work

Also note:

• Companion version
• PTZControlConsole release version
• selected camera name or device path
• which buttons worked and which did not