videohubctrl - Blackmagic Videohub control application
======================================================

Blackmagic Design Videohub is SDI router device which can be controlled
over the network using very simple text based protocol which 'videohubctrl'
implements.

'videohubctrl' is tested with Blackmagic Design Micro Videohub 16x16 router
and probably will work with other Videohub models.

'videohubctrl' currently displays:

  - Input port labels
  - Output port labels
  - Output routing
  - Output locking

The following features found in bigger Videohub models are currently not
supported (I don't have the hardware):

  - Configuration of video processing units
  - Configuration of Video monitoring outputs
  - Configuration of Serial ports

Configuration of Videohub's network settings can be made using Blackmagic's
Windows program when the device is connected via USB.


License
=======

videohubctrl is released under MIT license.
See LICENSE-MIT.txt for full license terms.


Development
===========

The development is done using git. videohubctrl repository is hosted at

   http://github.com/gfto/videohubctrl

To clone the repository issue the following commands:

   git clone git://github.com/gfto/videohubctrl.git
   cd videohubctrl
   git submodule init
   git submodule update
   make

The code is developed and tested under modern Linux. It's also compiled from
time to time under OS X but it's not tested there.


Updating the code
=================

To update cloned videohubctrl, go to the directory where the repository
is cloned and run the following commands:

   git fetch origin
   git merge origin/master
   git submodule update
   make clean all

videohubctrl's master branch should always be useful so it is safe to
use it instead of official release. The master branch will always
be better than any released version.


Command line parameters
=======================

videohubctrl is controlled using command line parameters. Here is a list
of supported command line parameters:

 Usage: videohubctrl --host <host> [..commands..]

Main options:
 -s --host <hostname>       | Set device hostname.
 -p --port <port_number>    | Set device port (default: 9990).

Misc options:
 -v --verbose               | Enable verbose logging.
 -q --quiet                 | Suppress warnings.
 -h --help                  | Show help screen.
 -V --version               | Show program version.

Commands:
 -i --info                  | Show device info (default command).


Example usage
=============

TODO: Add examples once set commands are done.


Example output
==============

Here is how videohubctrl output looks like:

|-----------------------------------------------------------------------------|
gf@gf:~/git/videohubctrl$ ./videohubctrl --host sdi-matrix
videohubctrl Version: 0.1 Git: 0.1

Protocol version: 2.4
Model name: Blackmagic Micro Videohub
Unique ID: 7c2e0d021714
Video inputs: 16
Video processing units: 0
Video outputs: 16
Video monitoring outputs: 0
Serial ports: 0

----------------------------------------------------------------------------
|  # | x | Input name                     | Output name                    |
----------------------------------------------------------------------------
|  1 | L | Windows 1                      | Enc1 3                         |
|  2 | L | Windows 2                      | Enc1 2                         |
|  3 | L | Windows 3                      | Enc1 1                         |
|  4 | L | Windows 4 HD                   | Enc1 1                         |
|  5 |   | Input 5                        | Output 5                       |
|  6 |   | Input 6                        | Output 6                       |
|  7 |   | Input 7                        | Output 7                       |
|  8 |   | Input 8                        | Output 8                       |
|  9 | L | Input 9                        | Enc1 4                         |
| 10 |   | Input 10                       | Enc1 4                         |
| 11 |   | Input 11                       | Output 11                      |
| 12 | L | DPlay1                         | Output 13                      |
| 13 | L | DPlay2                         | Denc                           |
| 14 |   | Input 14                       | Output 14                      |
| 15 |   | Input 15                       | Output 15                      |
| 16 |   | Loopback                       | Loopback                       |
----------------------------------------------------------------------------

gf@gf:~/git/videohubctrl$
|-----------------------------------------------------------------------------|


Reporting bugs
==============

If you think you have found bug in videohubctrl, please report it to the
e-mail listed in Contact section (see below) of this README file.

When reporting bugs, please send the whole output that videohubctrl generated
(preferably by using --verbose option) and also the full command line which
you used and describe what you think the videohubctrl does wrong.


Releases
========

Official releases can be downloaded from videohubctrl home page which is

   http://georgi.unixsol.org/programs/videohubctrl/


Contact
=======

For requests, patches, bug reports, complaints and so on send e-mail to

   Georgi Chorbadzhiyski <georgi@unixsol.org>