If you need to use your own Software Control program from a PC or WORKSTATION with an RS-232 or LAN port, the device allows communication
through an ASCII code protocol.
The device treats any character that it receives on the RS-232 or LAN as a possible command but only accepts legal commands.
There is no starting/ending code needed in a command string.
A command can be a single character typed on a keyboard and does not require any special character before or after it.
(It is not necessary to press "ENTER" on the keyboard). A command can be preceded by a value (See chapter A-2).
When the device receives a valid command, it will execute the command. Then it will send back the status of the parameters that have changed due
to this command.
If the command cannot be executed (value out of range, no signal on the selected input),etc. The device will just sends back the current status of
the corresponding parameters.
If the command is invalid, an error response will be returned to the control device. All responses returned to the control device end with
a carriage return <CR> and a line feed <LF> signaling the end of the response character string (see chapter A-3).
A2: Commands structure
The above listed devices share the same code structure.
Commands are made of numerical values for arguments followed by the command characters (one or Two case-sensitive alphabetical letters). Usually the same
characters (letters) are used for the [read Command] as well as the [write command].
The indexes are defined numbers indicating the how the arguments for the command apply. For example a layer number, an input number, a preset number, etc.
They are separated with a comma.
There are commands without index and others with up to 3 indexes. Each index is followed by a comma character. The final argument, also refered to as the “value”
does not have a comma between it and the command.
2
A [write command] is made of indexes followed by the numerical value followed by the command characters.
Write command = [[index,] ...] + Value + Character (s) code (s)
For example: “1,2,0IN” or “4YB”
A [read command] is made of indexes followed immediately by the command characters. (no numerical value)
Read command = [[index,] ...] Character (s) code (s)
For example: “1,2,IN” or “YB”
A3: Examples
Document notation:
1) Command without index : SWITCHER_MODE
Command to set the switcher mode to mixer mode: 0CM
Answer: CM0<CR><LF> which mean that the device is now working in mixer mode.
2) Command with 1 index : OFORMAT
Command to set the Main output format to XGA: 0,12OF
Answer: OF0,12<CR><LF> which mean that the main output format is now 1024x768
3) Command with 2 indexes : PE_INPUTNUM
Command to set the input 4 displayed in background layer of Next Preset: 1,2,4IN
Answer: IN1,1,4<CR><LF> which mean that the background layer of the next preset will display the input 4 signal
4) Read command without index : TAKEAVA
Read command to know if the TAKE command is available: TA
Answer: TA1<CR><LF> which mean that the device is ready to accept the TAKE command.
3
5) Read command with 2 indexes : SET_ASPECT_RATIO_OUT
Read command to know how is displayed a signal plugged on the input 4: 3,so
Answer: so3,2<CR><LF> which mean that the input 4 is displayed cropped
A4: Error codes
Answer: E10<CR><LF> which mean invalid command
Answer: E11<CR><LF> which mean index value error (index value out of range)
Answer: E12<CR><LF> which mean index number error (too or few indexes)
Some commands are only available as [Read command], they are status and are colored in blue as this line.
Some commands are colored in yellow as this line to indicate they were added or modified in this version.
A5 COMMUNICATION PORTS
4
Read /
Min
Max
Default
Apply factory settings to the
Auto reset
Auto reset
Preset management in matrix mode
Group Name CmdRespDescription
Request the retrieval of all the
variables
device( except image settings )
FLASH memory writing in progess.
Do not power off
Progress percent of the slow
operation
from the front panel
SYSTEM
CONTROLS
DIESE # #
READY * * Ready Device Flag Rd 0 1 0
DEV ? DEV MMS device type Rd 86 86 86 86 = EKS-400
UPDATER yU yU Device reboot for update Rd/Wr 0 255 0 1 then 254 => Reboot
FACTORYRESET YR YR
POSMEMORYRESET YE YE Erase stored image settings Rd/Wr 0 1 0
CSTORE YS YS
COPKIND CK CK Kind of slow in-progress operation Rd 0 6 0
COPPROGRESS CP CP
PRESET_MATRIX_MGMT CR CR
SWITCHER_MODE CM CM Device operating mode Rd/Wr 0 1 0
Write
Value
value
Rd/Wr 0 1 0
Rd/Wr 0 1 0
Rd 0 1 0
Rd 0 100 0 Percent : 0 to 100%
Rd/Wr 0 3 0
Values Index #1 Index #2
value
0= Initialization in progress
1 = Ready
0 = Free
1 = Flash writing in progress
0 = No lock
1 = Locked menu
2 = Locked front panel
1, …, 8 = Brightness level,
12,5% step
1, …, 100 = Brightness level,
1% step
0 = None
1 = Auto centering
2 = Auto setting
3 = StandBy
4 = Picture recording
5 = Reset to default factory
setting
6 = Reset User settings
0 = Preset management for
both outputs
1 = Preset management for
current output
2 = Preset management for
output 1
3 = Preset management for
output 2
0 = Seamless switcher mode
1 = Matrix mode
5
Read /
Min
Max
Default
AXION
AUTO_LOCK
AUTO_TAKE
Automatic Take after an input
AUTO_STEPBACK
Automatic preset toggle after a
Group Name CmdRespDescription
MATRIX_MIRROR Cm Cm
yA yA Device is driven by Orchestra Rd/Wr 0 1 0
YL YL
YT YT
Ys Ys
FREEZE_MODE Ym Ym Input freeze mode Rd/Wr 0 1 0
PROG_KEY_ET YM YM
Enable/Disable the mirror mode in
matrix mode
Forbide the use of a signal-less
input
change
TAKE
ELEMENT TRANSITION of the
effect programmable keys
Write
Value
value
Rd/Wr 0 3 0
Rd/Wr 0 1 1
Rd/Wr 0 1 0
Rd/Wr 0 1 0
Rd/Wr 0 4 2
Values Index #1 Index #2
value
0 = No copy
1 = Full copy
2 = Source copy and position H
Flip
3 = Source copy, data and
position H Flip
0 = Device is not driven by
ORC-50
1 = Device is driven by Orc-50
0 = Signal less input can be
selected
1 = Signal less input can not be
selected
0 = AUTO-TAKE Disable
1 = AUTO-TAKE Enable
0 = AUTO- PRESET-TOGGLE
Disable
1 = AUTO- PRESET-TOGGLE
Enable
0 = Freeze by input
1 = Freeze all inputs
0 = Cut
1 = CleanCut
2 = Fade
3 = Slide (associée à 1
trajectoire)
4 = Wipe (associée à 1
trajectoire)
0 = Background
Frame for output 1
1 = Background
Frame for output 2
in matrix mode
2 = Background
Layer for output 1
3 = Pip 1 Layer for
output1
Background Layer
for output 2 in
matrix mode
4 = Pip 2 Layer for
output1
5 = Pip 3 Layer for
output1 in
quadravision mode
Pip1 Layer for
output 2 in matrix
mode
6 = Logo 1
7 = Logo 2
8 = Audio Output 1
9 = Audio Output 2
0 = Fade
programmable key
1 = User 1
programmable key
2 = User 2
programmable key
6
Read /
Min
Max
Default
Fill PIP with black depending on the
wS wS
wQ wQ
wN wN
wF wF
Group Name CmdRespDescription
PROG_KEY_TW YN YN
PROG_KEY_ED YO YO
FRAME_ALERT Yf Yf
TRANSPARENT_BACKGROUND Yt Yt
BLACK_FILL bF bF
DISABLE_ID bI bI
STDBYSTATUS
STDBYREQUEST
STANDBY
STDBYPROJ_ON
STDBYPROJ_OFF
TRANSITION WAY of the effect
programmable keys
Duration of the effect associated to
the effect programmable keys
Back-up input when an input loose
its signal
Disable the the black fiilng of the
bakgrounfd live layer
aspect ratio
Disable Frame and Ids on the
preview output
Standby mode Rd/Wr 0 1 0
Request for standby or wake up Rd/Wr 0 1 0
Message to wake-up an output
display device ( 50 characters)
Message to send an output display
device to sleep ( 50 characters)
Write
Value
value
Rd/Wr 0 10 0
Rd/Wr 0 255 10 Unit = 1/10s
Rd/Wr 0 14 0
Rd/Wr 0 1 1
Rd/Wr 0 1 0
Rd/Wr 0 1 0
Rd/Wr 0 255 0 min = 0 max = 49
Rd/Wr 0 255 0 min = 0 max = 49
Values Index #1 Index #2
value
0 = Left to right
1 = Right to left
2 = Bottom to top
3 = Top to bottom
4 = Vertical from/to center
5 = Horizontal from/to center
6 = H&V rom/to center
7 = From SW to NE
8 = From SE to NW
9 = From NW to SE
10 = From NE to SW
0 = No input
1 = Input1
2 = Input2
3 = Input3
4 = Input4
5 = Input5
6 = Input6
9 = Input9
10 = Input10
11 = Input11
12 = Input12
13 = Input13
14 = Input14
0 = use BLACK_FILL
1 = Disable black filling only for
background
0 = Disable black filling
1 = Enable black filling
0 = Normal mode
1 = Standby mode
0 = Wake up
1 = Standby
0 = Fade
programmable key
1 = User 1
programmable key
2 = User 2
programmable key
0 = Fade
programmable key
1 = User 1
programmable key
2 = User 2
programmable key
7
Read /
Min
Max
Default
wR wR
wC wC
Auto
Group Name CmdRespDescription
STDBYPROJ_RATE
STDBYPROJ_CTRL
VERI1 xi xi Byte 0 and 1 of the device ID Rd 0 65535 0 ex : AAAA
VERI2 xj xj Byte 2 and 3 of the device ID Rd 0 65535 0 ex : AAAA
VERI3 xk xk Byte 4 and 5 of the device ID Rd 0 65535 0 ex : AAAA
VERI4 xl xl Byte 6 and 7 of the device ID Rd 0 65535 0 ex : AAAA
VERK xK xK
VERSION
VERV xV xV Variable set version Rd 0 65535 42
VERUPD xU xU Updater version Rd 0 65535 0
OPT yo yo Detected options Rd 0 65535 0
REV xR xR Moher board revision Rd 0 255 0
INPUT IN_AUTOSET_ALL Ia Ia
Output display device UART speed Rd/Wr 0 3 2
Rd/Wr 0 4 0
Checksum/version of the
programmable components
-setting request for all the
inputs
Write
Value
value
Rd/Wr 0 65535 0
Rd/Wr 0 1 0
Values Index #1 Index #2
value
0 = 1200bauds
1 = 2400bauds
2 = 9600bauds
3 = 19200bauds
0 = No request
1 = Wake up request
2 = Standby request
3 = Clear Wake up message
4 = Clear standby message
bit 0 = Lan Module
bit 1 = SDI In 1 board (SDI 1
and 2)
bit 2 = Recording board
bit 3 = CF Caecina
bit 4 = CF Fannia
bit 5 = CF Thrasea
bit 6 = SDI In 2 board (SDI 3
and 4)
bit 7 = Audio Evolution
bit 8 = HDCP DVI In Evolution
0 = Number of
programmables
components
1 = Main microcontroler
2 = Front panel
micro-controler
3 = FPGA Caecina
4 = FPGA Fannia
5 = FPGA Thrasea
6 = Synchro CPLD
0 = Does not belong to any VIS
Group
1 = Groupe VIS 1 group for
analog input
2 = Groupe VIS 2 group for
analog input
3 = Groupe VIS 3 group for
analog input
0 = Less than 10 meter cable
length
1 = 5 to 20 meters cable length
2 = More than 15 meters cable
length
IN_KEYING_INVERT KI KI Invert keying area Rd/Wr 0 1 0
IN_KEYING_GRAB_ENABLE Kg Kg
IN_KEYING_GRAB_GET Kc Kc
IN_KEYING_GRAB_H Kh Kh Horizontal position of the grabber Rd/Wr 0 65535 32768 Precent of OSCREEN_UTIL_V
IN_KEYING_GRAB_V Kv Kv Vertical position of the grabber Rd/Wr 0 65535 32768
SIG_HPOL sh sh Input H sync polarity Rd 0 1 0
INPUT
STATUS
SIG_VPOL sv sv Input V sync polarity Rd 0 1 0
Enable/disable the keying color
grabber mode
Capture the coolor selected by the
grabber and apply the settings
SET_ASPECT_RATIO_IN si si Input image aspect ratio Rd/Wr 0 4 0
SET_ASPECT_RATIO_OUT so so Output image aspect ratio Rd/Wr 0 3 1
Write
Value
value
Values Index #1 Index #2
value
0 = 4/3 Fullscreen
1 = 4/3 with 16/9 content +
black stripes
2 = 4/3 with 2.35 content +
black stripes
3 = 4/3 with 16/9 content
4 = 19/9 with 4/3 content +
black stripes
0 = Distorted, input aspect ratio
not preserved
1 = Not distorted, black bands
added
2 = Not distorted, no black
bands added
3 = Not distorted and no scaling
0 = Current preset
1 = Next preset
2 = Previous
preset
0 = Left to right
1 = Right to left
2 = Bottom to top
3 = Top to bottom
4 = Vertical from/to center
5 = Horizontal from/to center
6 = H&V rom/to center
7 = From SW to NE
8 = From SE to NW
9 = From NW to SE
10 = From NE to SW
1
2
3
4
5
6
7
10 = Memory
Preset 8
0 = Background
Frame for output 1
1 = Background
Frame for output 2
in matrix mode
2 = Background
Layer for output 1
3 = Pip 1 Layer for
output1
Background Layer
for output 2 in
matrix mode
4 = Pip 2 Layer for
output1
5 = Pip 3 Layer for
output1 in
quadravision mode
Pip1 Layer for
output 2 in matrix
mode
6 = Logo 1
7 = Logo 2
8 = Audio Output 1
9 = Audio Output 2
54
Read /
Min
Max
Default
3 = Memory Preset
4 = Memory Preset
5 = Memory Preset
6 = Memory Preset
7 = Memory Preset
8 = Memory Preset
9 = Memory Preset
Group Name CmdRespDescription
PE_OPENING_DURATION oD oD Layer opening transition duration Rd/Wr 0 255 10 Unit = 1/10s
Write
Value
value
Values Index #1 Index #2
value
0 = Current preset
1 = Next preset
2 = Previous
preset
1
2
3
4
5
6
7
10 = Memory
Preset 8
0 = Background
Frame for output 1
1 = Background
Frame for output 2
in matrix mode
2 = Background
Layer for output 1
3 = Pip 1 Layer for
output1
Background Layer
for output 2 in
matrix mode
4 = Pip 2 Layer for
output1
5 = Pip 3 Layer for
output1 in
quadravision mode
Pip1 Layer for
output 2 in matrix
mode
6 = Logo 1
7 = Logo 2
8 = Audio Output 1
9 = Audio Output 2
0 = Current preset
1 = Next preset
2 = Previous
preset
0 = Left to right
1 = Right to left
2 = Bottom to top
3 = Top to bottom
4 = Vertical from/to center
5 = Horizontal from/to center
6 = H&V rom/to center
7 = From SW to NE
8 = From SE to NW
9 = From NW to SE
10 = From NE to SW
1
2
3
4
5
6
7
10 = Memory
Preset 8
0 = Background
Frame for output 1
1 = Background
Frame for output 2
in matrix mode
2 = Background
Layer for output 1
3 = Pip 1 Layer for
output1
Background Layer
for output 2 in
matrix mode
4 = Pip 2 Layer for
output1
5 = Pip 3 Layer for
output1 in
quadravision mode
Pip1 Layer for
output 2 in matrix
mode
6 = Logo 1
7 = Logo 2
8 = Audio Output 1
9 = Audio Output 2
57
Read /
Min
Max
Default
3 = Memory Preset
4 = Memory Preset
5 = Memory Preset
6 = Memory Preset
7 = Memory Preset
8 = Memory Preset
9 = Memory Preset
Available TAKE flag
Group Name CmdRespDescription
PE_CLOSING_DURATION cD cD Layer closing transition duration Rd/Wr 0 255 10 Unit = 1/10s
TAKE TK TK
TAKEAVA TA TA
TAKEINFO TI TI TAKE information Rd 0 2 0
TBAR NT NT TBAR value Rd/Wr 0 10000 0 Unit = 0,01%
13 = Reset of layer properties
14 = Background Live + Top
Left PiP
15 = Background Live + Top
Right PiP
16 = Background Live + Bottom
Left PiP
17 = Background Live + Bottom
Right PiP
18 = Background Frame + 2
Left Right PiPs
19 = Background Frame + 2
Top Bottom PiPs
20 = Background Frame + 1
Right PiP + 2 Top Bottom PiPs
21 = Background Frame + 1
Left PiP + 2 Top Bottom PiPs
PiP + 2 Left Right PiPs
23 = Background Frame + 1
Bottom PiP + 2 Left Right PiPs
24 = Background Frame + 3
horizontal PiPs
25 = Background Frame + 3
diagonal PiPs
OBACKCOLORLUMA OI OI Output background brightness Rd/Wr 0 240 0
Output background pre-defined
color
Write
Value
value
Rd/Wr 0 32 0
Values Index #1 Index #2
value
0 = Black
1 = Navy blue
2 = Blue
3 = Green Blue
4 = Water Blue
5 = Turquoise blue
6 = Dark green
7 = Green
8 = Lime
9 = Light green
10 = Dark red
11 = Red
12 = Tomato red
13 = Bordeaux
14 = Brown
15 = Chocolate
16 = Orange
17 = Gold
18 = Yellow
19 = Indigo blue
20 = Purple
21 = Light red
22 = Fuchsia
23 = Salmon
24 = Rose
25 = Olive reen
26 = Grey
27 = Silver
28 = Lavender blue
29 = Beige
30 = Azur
31 = White
32 = Custom
Frame rate of the reference signal Rd 0 65535 0 Unit = 1/100Hz
REFERENCE
REFREQUEST
REFCURRENTREQUEST
REFMODE
REFCURRENTMODE
REFFREQ
Write
Value
value
Rd/Wr 0 16 0
Values Index #1 Index #2
value
0 = Analog input 1 as reference
1 = Analog input 2 as reference
2 = Analog input 3 as reference
3 = Analog input 4 as reference
4 = Analog input 5 as reference
5 = Analog input 6 as reference
8 = DVI 1 input as reference
9 = DVI 2 input as reference
10 = SDI 1 input as reference
11 = SDI 2 input as reference
12 = SDI 3 input as reference
13 = SDI 4 input as reference
14 = Back End 1 as reference
15 = Back End 2 as reference
16 = Back End 3 as reference
0 = Analog input 1 as reference
1 = Analog input 2 as reference
2 = Analog input 3 as reference
3 = Analog input 4 as reference
4 = Analog input 5 as reference
5 = Analog input 6 as reference
8 = DVI 1 input as reference
9 = DVI 2 input as reference
10 = SDI 1 input as reference
11 = SDI 2 input as reference
12 = SDI 3 input as reference
13 = SDI 4 input as reference
14 = Back End 1 as reference
15 = Back End 2 as reference
16 = Back End 3 as reference
0 = Internal
1 = Follow x1/2
2 = Follow x1
3 = Follow x2
4 = Follow x3
5 = Asynchronous Follow
0 = Internal
1 = Follow x1/2
2 = Follow x1
3 = Follow x2
4 = Follow x3
5 = Asynchronous Follow
0 = Normal mode
1 = Memory recall of logos and
frames
2 = Logo recording mode
3 = Animated logo recording
mode
4 = Frame recording mode
5 = Deleting picture mode
If PMODE = Savexxx => Store
the PCAPTURE_INDEX image
If PMODE = Erasexxx =>
Delete the
image
PCAPTURE_KEYING_GRAB_H PU PU Keying grabber position H Rd/Wr 0 65535 32768 Percent of OSCREEN_UTIL_V
PCAPTURE_KEYING_GRAB_V PV PV Keying grabber position V Rd/Wr 0 65535 32768
PCAPTURE_BACK_COLOR Pc Pc Cutout color for picture capture Rd/Wr 0 7 0 0 to 7
PCAPTURE_CAPTURE_TIME Pt Pt Capture time for an animated logo Rd/Wr 0 100 0
PCAPTURE_MAX_FRAME Pm Pm
PCAPTURE_FRAME_COUNT PN PN
PCAPTURE_REFRESH_INTERVAL PI PI
PCAPTURE_INDEX PX PX ID of the picture to capture Rd/Wr 0 16 0
Keying update (capture and apply
new value)
Maximal number of frames of an
animated logo
Number of frames of an animated
logo
Time between 2 frames of an
animated logo
Write
Value
value
Rd/Wr 0 1 0 Percent of OSCREEN_UTIL_H
Rd 1 255 80 1 à 255
Rd/Wr 1 255 1
Rd/Wr 1 10000 56 Unit = 1ms
Values Index #1 Index #2
value
0 = Disable the grabber
1 = Enable the grabber
0 = 0s
100 = 10s
0 = No Picture
1 = Logo 1
2 = Logo 2
3 = Logo 3
4 = Logo 4
5 = Logo 5
6 = Logo 6
7 = Logo 7
8 = Logo 8
9 = Frame 1
10 = Frame 2
11 = Frame 3
12 = Frame 4
13 = Frame 5
14 = Frame 6
15 = Frame 7
16 = Frame 8
67
Read /
Min
Max
Default
Group Name CmdRespDescription
PSTATUS_WIDTH Pw Pw Picture H size Rd 0 32767 0
PSTATUS_HEIGHT Ph Ph Picture V size Rd 0 32767 0
Write
Value
value
Values Index #1 Index #2
value
1 = Logo 1
2 = Logo 2
3 = Logo 3
4 = Logo 4
5 = Logo 5
6 = Logo 6
7 = Logo 7
8 = Logo 8
9 = Frame 1
10 = Frame 2
11 = Frame 3
12 = Frame 4
13 = Frame 5
14 = Frame 6
15 = Frame 7
16 = Frame 8
1 = Logo 1
2 = Logo 2
3 = Logo 3
4 = Logo 4
5 = Logo 5
6 = Logo 6
7 = Logo 7
8 = Logo 8
9 = Frame 1
10 = Frame 2
11 = Frame 3
12 = Frame 4
13 = Frame 5
14 = Frame 6
15 = Frame 7
16 = Frame 8
68
Read /
Min
Max
Default
Group Name CmdRespDescription
PSTATUS_STYLE Ps Ps Logo style Rd 0 2 0
PSTATUS_FRAME_COUNT Pn Pn
Number of frames of an animated
logo
Write
Value
value
value
Rd 1 255 1
Values Index #1 Index #2
1 = Logo 1
2 = Logo 2
3 = Logo 3
4 = Logo 4
5 = Logo 5
6 = Logo 6
LANRESET nr nr LAN factory parameters reset Rd/Wr 0 1 0
LANSTORE ns ns LAN parameters update Rd/Wr 0 1 0
LANIP nw nw LAN devices addresses Rd/Wr 0 255 192 IP : 0 to 255
LANPORT np np LAN port numbers Rd/Wr 0 65535 10500
LANNETMASK nk nk LAN netmask Rd/Wr 0 24 8 Number of 0bits from the right
LANPROTOCOL nt nt LAN protocol Rd/Wr 0 1 1
Write
Value
value
Rd/Wr 1 10000 56 Unit = 1ms
Values Index #1 Index #2
value
0 = Enable RS232 ( disable
LAN )
1 = Enable LAN ( disable
RS232 )
Local port : 10000 à 10999
Remote port : 0 à 65500
ID of the Sdi channel to desembed
for left channel
ID of the Sdi channel to desembed
for right channel
Information of audio channel
presence for SDI inputs
Write
Value
value
Rd/Wr 0 15 0
Rd/Wr 0 15 1
Rd 0 1 1 1 : Locked
Values Index #1 Index #2
value
0 = no delay
500ms = max delay
0 = réglage manuel du Delay, 1
= reglage automatique du delay
0 = Group A – Channel 1
1 = Group A – Channel 2
2 = Group A – Channel 3
3 = Group A – Channel 4
4 = Group B – Channel 1
5 = Group B – Channel 2
6 = Group B – Channel 3
7 = Group B – Channel 4
8 = Group C – Channel 1
9 = Group C – Channel 2
10 = Group C – Channel 3
11 = Group C – Channel 4
12 = Group D – Channel 1
13 = Group D – Channel 2
14 = Group D – Channel 3
15 = Group D – Channel 4
0 = Group A – Channel 1
1 = Group A – Channel 2
2 = Group A – Channel 3
3 = Group A – Channel 4
4 = Group B – Channel 1
5 = Group B – Channel 2
6 = Group B – Channel 3
7 = Group B – Channel 4
8 = Group C – Channel 1
9 = Group C – Channel 2
10 = Group C – Channel 3
11 = Group C – Channel 4
12 = Group D – Channel 1
13 = Group D – Channel 2
14 = Group D – Channel 3
15 = Group D – Channel 4