background image

 

 

11 

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

 
 

 2.6 

 

Command indexes and Command values 

As explained in chapter 

§VIO4K_control_principle

VIO 4K™ commands allow reading or writing values in 

multidimensional  registers.  For  these,  indexes  values  must  be  supplied.  For  simple  registers  (without 
dimension), reading or writing commands don’t need indexes values. 

Indexes values

: Depending on the command, you can have to specify from 0 to 3 indexes values. They 

indicate on which dimension the command relates. For example, the “OUT_FORMAT_STATUS” command 
which gives the format of the output, requires an index value to indicate one of the outputs.

 

No wildcard exists, all required indexes values shall be supplied. Some indexes values have names starting 

with  “DIM_”,  meaning  dimension.  For  example,  the  “IN_LABEL”  command  giving  the  name  of  an  input, 
always requires a “DIM_INPUT” index value indicating the number of the input. 

Indexes values are detailed in the “VIO4K_TPP_variables_for_v02-00-7X.xls” document. 

Command value

: This is the register value. In a write command, it indicates the new value that you want 

to be applied. In a read answer, it indicates the current state of the command (current register value). A 
write command is only distinguished from a read command due to the presence of the numerical or string 
value just before the command letters.  

A command value can be numerical or string: 

 

Numerical value should be integer (no space, no decimal part nor engineer notation) and made 
only of digits 

 

A  string  is  made  of  displayable  7bits  ASCII  characters,  surrounded  by  quotation  mark,  with  a 
length up to the specified maximum number of characters. (e.g. “My first show”) 

To use quotation mark in a string, it must be preceded by a backslash \”. The double backslash 
sequence \\ produces a normal literal backslash. (e.g. “My \”first\” input”, “C:\\Folder\\File”) 

The value types are detailed in the “VIO4K_TPP_variables_for_v02-00-7X.xls” document.  

A value written in a register remains until modified by a new write command or by the device itself. This 

allows options to be written only once. 

All registers have a default value, noted in the detailed tables. 

You  must  be  careful  on  value  range,  which  depends  on  multiple  factors,  like  device  type,  device 

configuration or current situation. Value range have names starting with “ENUM_”, else, if no enumeration 
name exist, value must be comprise between given “min value” and “max value”. 

Commands values are detailed in the “VIO4K_TPP_variables_for_v02-00-7X.xls” document. 

 2.7 

 

Multiple controllers 

Multiple controllers are allowed, limited to 5, with TCP protocol. 

No priority exists, in case of simultaneous writing of the same command, the device applies both, one 

after the other. In all cases, controllers must take into account the last answer received. 

Summary of Contents for VIO 4K

Page 1: ...VIO 4K Ref V701 TPP Programmer s Guide For version v02 00 7X...

Page 2: ...VIO 4K TPP PROGRAMMER S GUIDE FOR v02 00 7X...

Page 3: ...exes and Command values 11 2 7 Multiple controllers 11 3 COMMON 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...

Page 4: ...xample 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...

Page 5: ...sic 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...

Page 6: ...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...

Page 7: ...ter 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 L F symbol Com...

Page 8: ...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 th...

Page 9: ...e depending on the error and is ended with C R L F characters 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...

Page 10: ...e 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 mul...

Page 11: ...he numerical or string value just before the command letters A command value can be numerical or string Numerical value should be integer no space no decimal part nor engineer notation and made only o...

Page 12: ...VIO 4K comprising Socket opening Device type checking Command set version checking VIO 4K registers readback Keeping a connection alive with a VIO 4K Shutting down or rebooting the VIO 4K device Swit...

Page 13: ...nd gives the device type Syntax L F Answer DEV value C R L F The numerical value gives the connected device type Other values match other Analog Way devices o command set version checking This read on...

Page 14: ...d of the enumeration is signaled when the DIESE register automatically returns to the value 0 meaning that the controller must wait until receiving 0C R L F When value is equal to 3 the device works t...

Page 15: ...15 VIO 4K TPP PROGRAMMER S GUIDE FOR v02 00 7X 3 1 4 Example of connection establishment Picture 7 Example of connection establishment...

Page 16: ...overload typically at human rate It is advised to ping the device only when no communication occurs 3 2 2 Detailed command sequence Syntax val1 SYpig val1 is any numerical value that will be used and...

Page 17: ...starts the device by writing the value 1 Syntax 1SBrebL F OR Power off the device This command shuts down and powers off the device by writing the value 2 manual restart required Syntax 2SBreqL F OR S...

Page 18: ...ory User must particularly be careful with this mode if multiples remote controllers are connected Multiple controllers using those commands simultaneously would cause unpredictable results This can c...

Page 19: ...oller The recall Preset from memory action can be used automatically and with the manual apply mode This command allows to load a previously memorized preset 3 5 2 Detailed commands sequence Load a pr...

Page 20: ...a layer of a screen It can be used automatically and with the manual apply mode The PE_INPUTNUM register is used to know and change the source displayed in the layer of the preset Warning In manual mo...

Page 21: ...GUIDE FOR v02 00 7X 3 6 3 Example of changing a layer content auto apply mode Picture 13 Example of changing a layer content 3 6 4 Example of changing a layer content manual mode Picture 14 Example o...

Page 22: ...equence Load a view from memory Syntax bank screen input 1PBrcrL F bank is the memory index 64 memories addressed from 0 to 63 screen is the destination screen index 6 screens addressed from 0 to 5 in...

Page 23: ...loading a view to specific input manual mode Picture 17 Load a view from memory to specific input and apply later with transition 3 7 5 Example of changing a view to current input auto apply mode Pict...

Page 24: ...24 VIO 4K TPP PROGRAMMER S GUIDE FOR v02 00 7X 3 7 6 Example of loading a view to current input manual mode Picture 19 Load a view from memory to the current input and apply later with transition...

Page 25: ...of edge of the area of interest by writing the value 1 and disables with the value 0 Syntax output 1OUactL F Select pattern fit area This command defines if the pattern is shown on all format area by...

Page 26: ...output snapshots are regularly refreshed while frame snapshots are refreshed only on change Snapshot request rate must not be more than 1 per second Picture maximal size is 256 pixels width by up to...

Page 27: ...R v02 00 7X 4 NOTES 4 1 Using this document This document contains many internal links You can improve your navigation by using the previous page function as in the following example Picture 21 PDF re...

Page 28: ...28 VIO 4K TPP PROGRAMMER S GUIDE FOR v02 00 7X V1 00 Apr 03 2017...

Reviews: