aboutsummaryrefslogtreecommitdiffhomepage
path: root/backends/visca.md
blob: 101aa206ead597403e01d5931c876ebcc04db7de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
### The `visca` backend

The `visca` backend provides control of compatible PTZ (Pan, Tilt, Zoom) controllable cameras
via the network. The VISCA 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 the make
and model of your equipment.

This backend can connect to both UDP and TCP based camera control interfaces. On Linux, it can also control
devices attached to a serial/RS485 adapter.

#### 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 115200`	| none			| (Linux only) Device node for a serial port adapter connecting to the camera, optionally followed by the baudrate |
| `deadzone`	| `0.1`			| `0.1`			| Amount of event value variation to be ignored for relative movement commands |

#### Channel specification

Each instance exposes the following channels

* `pan`: Pan axis (absolute)
* `tilt`: Tilt axis (absolute)
* `panspeed`: Pan speed
* `tiltspeed`: Tilt speed
* `zoom`: Zoom position
* `focus`: Focus position
* `autofocus`: Switch between autofocus (events > 0.9) and manual focus drive mode
* `wb.auto`: Switch between automatic white balance mode (events > 0.9) and manual white balance mode
* `wb.red`, `wb.blue`: Red/Blue channel white balance gain values
* `home`: Return to home position
* `memory<n>`: Call memory <n> (if incoming event value is greater than 0.9)
* `store<n>`: Store current pan/tilt/zoom setup to memory <n> (if incoming event value is greater than 0.9)
* `move.left`, `move.right`, `move.up`, `move.down`: Relative movement with the currently set `panspeed` and `tiltspeed`

Example mappings:

```
control.pan > visca.pan
control.tilt > visca.tilt
control.btn1 > visca.memory1
```

#### Compatability list

| Manufacturer	| Exact model(s) tested		| Compatible models				| Result / Notes					|
|---------------|-------------------------------|-----------------------------------------------|-------------------------------------------------------|
| ValueHD	| VHD-V61			| Probably all ValueHD Visca-capable devices	| Everything works except for absolute focus control	|
| PTZOptics	| 				| Probably all of their PTZ cameras		| See ValueHD						|

#### 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. Some commands may not work with some manufacturer's cameras due to
different value ranges or command ordering.

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 compatibility list!