Skip to content

cli-help.md

Latest commit

 

History

History
397 lines (308 loc) · 11.3 KB

cli-help.md

File metadata and controls

397 lines (308 loc) · 11.3 KB

PTZControlConsole CLI Help

This file is generated by PTZControlConsole docs --output docs/generated.

Main help

PTZControlConsole 1.0.0.0

  list-devices                  List available camera devices.
  cam-device-info               Show camera device information and supported raw
                                ranges.
  get-preset-name               Print the friendly name of one preset.
  set-preset-name               Store the friendly name of one preset.
  clear-preset-name             Clear the friendly name of one preset.
  get-camera-name               Print the friendly name of one camera slot.
  set-camera-name               Store the friendly name of one camera slot.
  clear-camera-name             Clear the friendly name of one camera slot.
  get-directshow-camera-name    Print the Windows DirectShow camera name.
  set-directshow-camera-name    Set the Windows DirectShow camera name.
  swap-preset-names             Swap preset friendly names between two camera
                                slots.
  config                        Export or import preset and camera friendly-name
                                metadata.
  restore-home                  Restore the Logitech home position.
  restore-default               Restore driver default values.
  restore-preset                Restore a camera preset position.
  save-preset                   Save the current camera position as a preset.
  zoom-absolute                 Set an absolute zoom value.
  zoom-relative                 Change zoom by a relative delta.
  move-absolute                 Set absolute pan and/or tilt values.
  move-seek                     Experimentally seek absolute pan and/or tilt
                                values using relative movement.
  move-relative                 Change pan and/or tilt by relative deltas.
  help                          Display more information on a specific command.
  version                       Display version information.

list-devices

PTZControlConsole 1.0.0.0

list-devices
  List available camera devices.

Options:
  --help       Display this help screen.
  --version    Display version information.

cam-device-info

PTZControlConsole 1.0.0.0

cam-device-info
  Show camera device information and supported raw ranges.

Options:
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.

get-preset-name

PTZControlConsole 1.0.0.0

get-preset-name
  Print the friendly name of one preset.

Options:
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.
  preset (pos. 0)      Required. Preset number 1..8.

set-preset-name

PTZControlConsole 1.0.0.0

set-preset-name
  Store the friendly name of one preset.

Options:
  -n, --friendlyname    Required. Friendly display name to store.
  -c, --camera          Camera device name fragment.
  -d, --device-path     Concrete camera device path.
  -s, --slot            PTZControl camera slot 1..3.
  --help                Display this help screen.
  --version             Display version information.
  preset (pos. 0)       Required. Preset number 1..8.

clear-preset-name

PTZControlConsole 1.0.0.0

clear-preset-name
  Clear the friendly name of one preset.

Options:
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.
  preset (pos. 0)      Required. Preset number 1..8.

get-camera-name

PTZControlConsole 1.0.0.0

get-camera-name
  Print the friendly name of one camera slot.

Options:
  -s, --slot    Required. PTZControl camera slot 1..3.
  --help        Display this help screen.
  --version     Display version information.

set-camera-name

PTZControlConsole 1.0.0.0

set-camera-name
  Store the friendly name of one camera slot.

Options:
  -s, --slot            Required. PTZControl camera slot 1..3.
  -n, --friendlyname    Required. Friendly display name to store.
  --help                Display this help screen.
  --version             Display version information.

clear-camera-name

PTZControlConsole 1.0.0.0

clear-camera-name
  Clear the friendly name of one camera slot.

Options:
  -s, --slot    Required. PTZControl camera slot 1..3.
  --help        Display this help screen.
  --version     Display version information.

get-directshow-camera-name

PTZControlConsole 1.0.0.0

get-directshow-camera-name
  Print the Windows DirectShow camera name.

Options:
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.

set-directshow-camera-name

PTZControlConsole 1.0.0.0

set-directshow-camera-name
  Set the Windows DirectShow camera name.

Options:
  -n, --friendlyname       Required. DirectShow friendly name to write.
  --acknowledge-warning    Skip the interactive registry risk confirmation.
  -c, --camera             Camera device name fragment.
  -d, --device-path        Concrete camera device path.
  -s, --slot               PTZControl camera slot 1..3.
  --help                   Display this help screen.
  --version                Display version information.

swap-preset-names

PTZControlConsole 1.0.0.0

swap-preset-names
  Swap preset friendly names between two camera slots.

Options:
  --slot-a     Required. First PTZControl camera slot 1..3.
  --slot-b     Required. Second PTZControl camera slot 1..3.
  --help       Display this help screen.
  --version    Display version information.

config

PTZControlConsole 1.0.0.0

config
  Export or import preset and camera friendly-name metadata.

Options:
  --export              Export metadata JSON to stdout or json-path.
  --import              Import metadata JSON from a file path.
  --help                Display this help screen.
  --version             Display version information.
  json-path (pos. 0)    JSON file path for config export.

restore-home

PTZControlConsole 1.0.0.0

restore-home
  Restore the Logitech home position.

Options:
  -t, --target         Required. Restore target: zoom, move, move-x, move-y, or
                       all. Home supports zoom, move, or all.
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.

restore-default

PTZControlConsole 1.0.0.0

restore-default
  Restore driver default values.

Options:
  -t, --target         Required. Restore target: zoom, move, move-x, move-y, or
                       all. Home supports zoom, move, or all.
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.

restore-preset

PTZControlConsole 1.0.0.0

restore-preset
  Restore a camera preset position.

Options:
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.
  preset (pos. 0)      Required. Preset number 1..8.

save-preset

PTZControlConsole 1.0.0.0

save-preset
  Save the current camera position as a preset.

Options:
  -n, --friendlyname    Friendly display name to store separately with
                        set-preset-name.
  -c, --camera          Camera device name fragment.
  -d, --device-path     Concrete camera device path.
  -s, --slot            PTZControl camera slot 1..3.
  --help                Display this help screen.
  --version             Display version information.
  preset (pos. 0)       Required. Preset number 1..8.

zoom-absolute

PTZControlConsole 1.0.0.0

zoom-absolute
  Set an absolute zoom value.

Options:
  -m, --mode           Required. Value mode: percent or raw.
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.
  value (pos. 0)       Required. Absolute zoom value.

zoom-relative

PTZControlConsole 1.0.0.0

zoom-relative
  Change zoom by a relative delta.

Options:
  -m, --mode              Required. Value mode: percent or raw.
  -c, --camera            Camera device name fragment.
  -d, --device-path       Concrete camera device path.
  -s, --slot              PTZControl camera slot 1..3.
  --help                  Display this help screen.
  --version               Display version information.
  value-delta (pos. 0)    Required. Relative zoom delta.

move-absolute

PTZControlConsole 1.0.0.0

move-absolute
  Set absolute pan and/or tilt values.

Options:
  -x, --pan            Pan axis value.
  -y, --tilt           Tilt axis value.
  -m, --mode           Required. Value mode: percent or raw.
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.

move-seek

PTZControlConsole 1.0.0.0

move-seek
  Experimentally seek absolute pan and/or tilt values using relative movement.

Options:
  --tolerance          (Default: 2) Allowed target distance in the selected
                       mode.
  --max-iterations     (Default: 30) Maximum relative correction attempts.
  --settle-ms          (Default: 250) Delay after each relative movement
                       attempt.
  -x, --pan            Pan axis value.
  -y, --tilt           Tilt axis value.
  -m, --mode           Required. Value mode: percent or raw.
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.

move-relative

PTZControlConsole 1.0.0.0

move-relative
  Change pan and/or tilt by relative deltas.

Options:
  -x, --pan            Pan axis value.
  -y, --tilt           Tilt axis value.
  -m, --mode           Required. Value mode: percent or raw.
  -c, --camera         Camera device name fragment.
  -d, --device-path    Concrete camera device path.
  -s, --slot           PTZControl camera slot 1..3.
  --help               Display this help screen.
  --version            Display version information.