Analog way VIO 4K User manual

VIO 4K
Ref. V701
TPP Programmer’s Guide
For version v02.00.7X

VIO 4K TPP PROGRAMMER'S GUIDE FOR v02.00.7X

3
VIO 4K TPP PROGRAMMER'S GUIDE FOR v02.00.7X
Table of contents
1INTRODUCTION.........................................................................................................................................................................5
1.1 References ..........................................................................................................................................................................5
1.2 Notices ................................................................................................................................................................................5
2CONTROLLING VIO 4K™ ............................................................................................................................................................6
2.1 Introduction ........................................................................................................................................................................6
2.2 Physical interfaces...............................................................................................................................................................6
2.3 Protocol...............................................................................................................................................................................6
2.4 Command principle and structure ......................................................................................................................................7
2.5 Commands sequencing .....................................................................................................................................................10
2.6 Command indexes and Command values .........................................................................................................................11
2.7 Multiple controllers........................................................................................................................................................... 11
3COMMON VIO 4K™ USE CASES...............................................................................................................................................12
3.1 Establishing a connection with a VIO 4K™ ........................................................................................................................13
3.2 Keeping a connection alive with a VIO 4K™ ......................................................................................................................16
3.3 Shutting down or rebooting the VIO 4K™ device..............................................................................................................17
3.4 Switching on manual commutation mode ........................................................................................................................ 18
3.5 Loading a Preset from memory.........................................................................................................................................19
3.6 Changing a source displayed in the layer..........................................................................................................................20
3.7 Loading a View from memory ...........................................................................................................................................22
3.8 Using patterns ................................................................................................................................................................... 25
3.9 Using snapshots ................................................................................................................................................................26
4NOTES .....................................................................................................................................................................................27
4.1 Using this document ......................................................................................................................................................... 27

4
VIO 4K TPP PROGRAMMER'S GUIDE FOR v02.00.7X
Pictures index
Picture 1: Write command example ......................................................................................................................................................... 7
Picture 2: Read command example .......................................................................................................................................................... 8
Picture 3: Valid answer structure.............................................................................................................................................................. 8
Picture 4: Error answer example............................................................................................................................................................... 9
Picture 5: Write sequence....................................................................................................................................................................... 10
Picture 6: Read sequence........................................................................................................................................................................ 10
Picture 7: Example of connection establishment ................................................................................................................................... 15
Picture 8: Example of keeping a connection alive .................................................................................................................................. 16
Picture 9: Select a preset - Web RCS....................................................................................................................................................... 19
Picture 10: Example of load preset from memory .................................................................................................................................. 19
Picture 11: Example of load a preset in manual mode ........................................................................................................................... 20
Picture 12: Changing a source - Web RCS ............................................................................................................................................... 20
Picture 13: Example of changing a layer content.................................................................................................................................... 21
Picture 14: Example of changing a layer content.................................................................................................................................... 21
Picture 15: Loading a view to an input - Web RCS.................................................................................................................................. 22
Picture 16 : Load a view from 20th bank slot to Input 2 HDMI................................................................................................................ 22
Picture 17 : Load a view from memory to specific input and apply later with transition....................................................................... 23
Picture 18: Load a view from the 19th bank slot to the current input .................................................................................................... 23
Picture 19 : Load a view from memory to the current input and apply later with transition................................................................. 24
Picture 20: Show a pattern in an output - Web RCS ............................................................................................................................... 25
Picture 21: PDF reader, Previous and Next page buttons....................................................................................................................... 27

5
VIO 4K TPP PROGRAMMER'S GUIDE FOR v02.00.7X
1 INTRODUCTION
This document provides information and guidance to control a VIO 4K™directly from controllers without
using the standard Web RCS. A basic knowledge of the machine is necessary, using the Web RCS.
TPP stands for Third Party Protocol.
1.1 References
(on ANALOG WAY web site)
VIO4K_TPP_variables_for_v02-00-7X.xls (VIO 4K™ v02.00.7X TPP command set)
VIO 4K™ v02.00.7X firmware updater
VIO 4K™User Manual
VIO 4K™Quick Start Guide
1.2 Notices
Pictures and drawings are non-contractual.
Specifications are subject to change without prior notice.

6
VIO 4K TPP PROGRAMMER'S GUIDE FOR v02.00.7X
2 CONTROLLING VIO 4K™
2.1 Introduction
VIO 4K™products are usually controlled by the user friendly Web RCS or by the VERTIGE high-end remote
controller, but a programming interface is also provided for automation applications.
A good practice is to setup the machine with the Web RCS and then control it with a few basic commands
like “preset recalling” and “layer input change”.
2.2 Physical interfaces
VIO 4K™ can be controlled through its rear Ethernet RJ45 plug:
labeled “ETHERNET”
10/100Mbps compatible
auto-MDIX (which avoid need of crossover cable to connect it directly to a computer)
VIO 4K™ can be controlled through its rear RS232 DB9 plug:
labeled “RS232”
1200Bds up to 115200 Bauds
3 wires straight cable, 8 data bits, 1 stop bit, no parity bit, no flow.
Warning: Enable RS232 may slow down device operations especially if a low baud rate is selected.
2.3 Protocol
Supported protocol is TCP/IP, parameters can be set up with front panel or Web RCS configuration
menus.
Default values are:
Protocol: TCP
DHCP client: yes
TPP port: 10600
Note: The VIO 4K™ TPP server can handle at most 5 clients simultaneously.

7
VIO 4K TPP PROGRAMMER'S GUIDE FOR v02.00.7X
2.4 Command principle and structure
2.4.1 VIO 4K™control principle
VIO 4K™functionalities are controlled through commands. Those commands allow reading or writing in
device registers.
VIO 4K™ TPP interface could be considered as a state machine, controlled by sending commands to read
or write its registers. Writing into registers modifies machine state. Current state of the machine is always
available by reading its registers.
Registers structure and size can range from a simple bit, up to multidimensional array of 32 bits words,
and also string. Note that reading or writing a value into a multidimensional register requires providing
indexes in addition to the register value.
Each register have a unique name, only made of letters, usually five, upper case or lower case. (three
exceptions having only one letter)
A command is made only of displayable ASCII characters (ranging from 0x21 up to 0x7E) and is ended
with a line feed character (LF) (ASCII 0x0A) that will be represented hereafter with the LFsymbol.
Commands are of 2 types: read commands or write commands, using the same syntax.
A write command is made of indexes values, followed by the register value, the register name and ended
by the LFcharacter.
A read command uses exactly the same syntax, except the register value that is omitted.
2.4.2 Write command structure
A write command is made of numeric values separated by a comma, followed by a group of up to 5 letters
defining the command and is ended with LF. (ASCII 0x0A)
Picture 1: Write command example
The last numerical field is the value to be written in the register.
The first numerical fields are “indexes values”, specifying on which dimension the command relates. The
number of indexes can range from 0 to 3 depending on the command.
(details in chapter §Command indexes and Command values)
Each command shall be ended with the LFcharacter. (ASCII 0x0A)

8
VIO 4K TPP PROGRAMMER'S GUIDE FOR v02.00.7X
2.4.3 Read command structure
A read command follows the same structure than the write command, simply with the value field
omitted. Please note that an index value is always followed by a comma.
Picture 2: Read command example
2.4.4 Valid answer structure
When a read or write command is valid, the device answers, giving the current register value. The answer
structure is symmetrical to the write or read command.
An answer is made of a group of letters (most often the same as the command) followed by numeric
values separated by comma, and ended with CRLFcharacters. (ASCII 0x0D and 0x0A)
Picture 3: Valid answer structure
Answer starts generally by the same group of letters than in the initial read or write command, followed
by indexes values, then register value and ending with CRLFcharacters.

9
VIO 4K TPP PROGRAMMER'S GUIDE FOR v02.00.7X
2.4.5 Error answer
When an invalid read or write command string is received, the device immediately answers with one of
the following error string.
Picture 4: Error answer example
Error message structure:
An error message is made of the capital letter E followed by a 2 digits value depending on the error and
is ended with CRLFcharacters. (ASCII 0x0D and 0x0A)
Here are returned error code and conditions covered:
E10: means “register name error”. It is usually due to a command field (i.e. five letters) that does
not match any legal command string.
E11: means “index value out of range”. It is usually due to a wrong index value.
E12: means “index number error”. It is usually due to an incorrect number of indexes, too or not
enough.
E13: means “value out of range”. It is usually due to a wrong value in a writing command.

10
VIO 4K TPP PROGRAMMER'S GUIDE FOR v02.00.7X
2.5 Commands sequencing
A complete command sequence is made of two parts: first, a read or write command issued by the
controller, second, the answer of the device. The answer can be used as an acknowledgment. Because the
processing of received commands is asynchronous, the answer delay is nor constant nor predictable, but on
the other side, this allows to send multiple commands in advance.
A good practice is to check commands acknowledgment before sending new block of commands.
2.5.1 Write sequence
Picture 5: Write sequence
2.5.2 Read sequence
Picture 6: Read sequence