diff options
| author | cbdev <cb@cbcdn.com> | 2020-08-15 13:45:23 +0200 |
|---|---|---|
| committer | cbdev <cb@cbcdn.com> | 2020-08-15 13:45:23 +0200 |
| commit | 15826f63185211ff3974b29370d04b8082be9c53 (patch) | |
| tree | 4e363f28428991a85f3c15a35080a863a5f53860 /backends/visca.md | |
| parent | 690aec061db4cfab50b998822628f732e115e11e (diff) | |
| download | midimonster-15826f63185211ff3974b29370d04b8082be9c53.tar.gz midimonster-15826f63185211ff3974b29370d04b8082be9c53.tar.bz2 midimonster-15826f63185211ff3974b29370d04b8082be9c53.zip | |
Add VISCA documentation, fix some issues
Diffstat (limited to 'backends/visca.md')
| -rw-r--r-- | backends/visca.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/backends/visca.md b/backends/visca.md new file mode 100644 index 0000000..26e523a --- /dev/null +++ b/backends/visca.md @@ -0,0 +1,50 @@ +### The `visca` backend + +The VISCA backend provides control of compatible PTZ (Pan, Tilt, Zoom) controllable cameras +via the network. This protocol has, with some variations, been implemented by multiple manufacturers +in their camera equipment. There may be some specific limits on the command set depending on make +and model of your equpipment. + +This backend can connect to both UDP and TCP based cameras. + +#### Global configuration + +The `visca` backend does not take any global configuration. + +#### Instance configuration + +| Option | Example value | Default value | Description | +|---------------|-----------------------|-----------------------|---------------------------------------------------------------| +| `id` | `5` | `1` | VISCA Camera address (normally 1 for network communication | +| `connect` | `10.10.10.1 5678` | none | Camera network address and port. Default connection is TCP, when optionally suffixed with the `udp` keyword, connection will be UDP | +| `device` | `/dev/ttyUSB0` | none | (Linux only) Device node for a serial port adapter connecting to the camera | + +#### Channel specification + +Each instance exposes the following channels + +* `pan`: Pan axis +* `tilt`: Tilt axis +* `panspeed`: Pan speed +* `tiltspeed`: Tilt speed +* `zoom`: Zoom position +* `focus`: Focus position +* `memory<n>`: Call memory <n> (if incoming event value is greater than 0.9) + +Example mappings: + +``` +control.pan > visca.pan +control.tilt > visca.tilt +control.btn1 > visca.memory1 +``` + +#### Known bugs / problems + +Value readback / Inquiry is not yet implemented. This backend currently only does output. + +Some manufacturers use VISCA, but require special framing for command flow control. This may be implemented +in the future if there is sufficient interest. + +Please file a ticket if you can confirm this backend working/nonworking with a new make or model +of camera so we can add it to the compatability list! |