User manual AKG SDXI-U2 V1.15 GENERAL DESCRIPTION

[. . . ] Also contains the description of these telegrams, which are supported by all SDXI devices, e. g. Describes all telegrams used for the AXENS Central Unit (AXCU), the AXENS talking station (AXTS) and the Salve Clock System US1. Describes all telegrams used to control the digital automatic mixer family ASx. [. . . ] 15 2. 6. 1 © Stemin GmbH · SDXI U2 Protocol Description V1. 15. doc · page 3 of 15 SDXI-U2 Serial ASCII Data Exchange Interface General Description V1. 15 © Stemin GmbH · SDXI U2 Protocol Description V1. 15. doc · page 4 of 15 SDXI-U2 Serial ASCII Data Exchange Interface General Description V1. 15 1 General description 1. 1 Protocol SDXI The SDXI-U2 (Serial Data Exchange Interface) should allow interacting, controlling and maintaining a variety of different devices. The serial interface was designed without any higher protocol function like a handshake or something equal. This interface allows the communication of embedded devices with a PC and/or among each other. Every device, a PC or the embedded device is responsible for the correct receiving and interpreting of the telegrams. This refers also to the timing-behaviour, this means that the devices must be able to react and process to the telegrams during runtime, without validating the timing conditions, which could lead to the loss of telegrams. A loss of a telegram can also cause a loss of data because for some telegram a repetition of the telegram is not possible. If the external device is fast enough and is controlled by an interrupt driven interface there should be no problem to handle the telegrams. 1. 2 Protocol Extension SDXI-U2 (ASCII Mode) The SDXI protocol includes a second, higher level protocol interface called SDXI-U2 protocol, which allows the user to communicate and control the device with a simple terminal program using an ASCII-based interface language. This SDXI-U2 protocol provides a subset of the regular SDXI telegrams respectively SDXI commands, to make the basic functions available for an easy access via various media control devices like AMX, Crestron or something similar. 1. 3 Serial Parameters To select a user specific baud rate, you can select a different baud rate using the according SDXI-U2 telegram. Default parameters: BAUDRATE: PARITY: STOPBIT: DATABITS: 9600 NONE (fixed) 1 (fixed) 8 (fixed) 1. 4 Availability of Telegrams The availability of each telegram depends on optional and device specific software modules as well. 1. 5 Note: Enabling Remote Control To enable the remote control functionality, it is first necessary to enable the remote interface of the device by sending a "Set Remote Interface" command to the device! © Stemin GmbH · SDXI U2 Protocol Description V1. 15. doc · page 5 of 15 SDXI-U2 Serial ASCII Data Exchange Interface General Description V1. 15 1. 6 Telegram Specification The following table shows the structure of the SDXI-U2 telegrams: Byte Index 0 1 2 variable variable Byte Quantity 1 1 2. . . 3 1. . . 3 2. . . 3 Meaning start byte telegram version Device Code Device Address Object Code value / example `U' (0x55H): Start of Telegram `2' (0x32H): signals that a SDXI-U2 telegram follows (ASCII mode) "DM" (Digital Mixer) "1", . . . , "999" "EN": Encoder "COM": ComPort variable variable 1. . . 3 2. . . 3 Object Address Command Code / Object Property "0", . . . , "255" Command Codes: "RR": "RL": "MU": "BD": variable variable variable variable variable variable variable variable variabel 1 1. . . 6 1 1. . . 6 1 1. . . 6 1 1. . . 6 1 Operator Parameter 1 (optional) Seperator (optional) Parameter 2 (optional) Seperator (optional) Parameter 3 (optional) Seperator (optional) Parameter 4 (optional) end byte encoder turn right encoder turn left mute channel Baudrate `=' set operator `?' request operator "-32767". . . "32767" `, ' "-32767". . . "32767" `, ' "-32767". . . "32767" `, ' "-32767". . . "32767" 0x0d (HEX) End of Telegram CR Example: ASCII HEX "U2DM1EN2=35<CR>" 55 32 44 4d 31 45 4e 32 3d 33 35 0d sets encoder 2 to value 35 (level) © Stemin GmbH · SDXI U2 Protocol Description V1. 15. doc · page 6 of 15 SDXI-U2 Serial ASCII Data Exchange Interface General Description V1. 15 2 Commands 2. 1 Definition of General Command Parameter Parameter transmission to the device transmission from the device Telegram definition Example of the Telegram optional parameter device address encoder number encoder value system control selection [<px>] <d> <e> <ev> <scs> 0 . . . 255 Symbol Range Description data will be send/transmitted to the device (device receives data) data will be send/transmitted from the device (device transmits data) Shows the telegram definition including abstract parameters as variables. Shows an example telegram with real values Parameters placed in square brackets are optional. 0 = reserved for broadcast address 1. . . 999 = device addresses 1. . . 10 1. . . 16 = automixer 4 / 2 / 2 = automixer 10 / 2 / 2 encoder value/setting according to the actual system control selection value (selection) of the system control encoder: 1: 2: 3: 4: 5: 6: 7: 8: 9: 10: = LEVEL = TREBLE = BASS = LOW CUT = LIMITER = AUTOMIXING = DUCKING = NOM. = LAST MIC ON = PAN BALANCE Mute State <mut> 0, 1 Mute state of the according encoder/channel: 0: encoder/channel not muted 1: encoder/channel muted "ON"-LED state of the according encoder: 0: LED is Off 1: LED is On "PEAK"-LED state of the according encoder: 0: LED is Off 1: LED is On 1. . . 10 1. . . 16 = automixer 4 / 2 / 2 = automixer 10 / 2 / 2 "ON"-LED State <onl> 0, 1 "PEAK"-LED State channel number channel level channel status <pkl> 0, 1 <c> <cl> <csx> 0 . . . 45 Represents the input level at the according channel 00000 . . . 45111 Represents the input level, the ON and the Peak LED state of channel x in the following format: <cl><mut><onl><pkl> <cl>xxx : first two number represent <cl> xx<mutl>xx : third number represents <mut> xxx<onl>x : fourth number represents <onl> xxxx<pkl>: fifth number represents <pkl> · SDXI U2 Protocol Description V1. 15. doc · page 7 of 15 © Stemin GmbH SDXI-U2 Serial ASCII Data Exchange Interface General Description V1. 15 2. 2 Version Commands 2. 2. 1 Dir Software Version (, , U2DM<d>SW?<CR>") Telegram U2DM<d>SW?<CR> U2DM1SW?<CR> Description This command requests the actual software version/info of the device. U2DM<d>SW=<p1>, <p2>, <p3><CR> Device returns the software version: <p1>: SW-Version: (e. g. : 102 = 1. 02) <p2>: Application Type 5: Digital Automixer 4 / 2 / 2 <p3>: OEM Version (reserved) U2DM1SW=121, 5, 0<CR> <p1>: SW-Version: 1. 21 <p2>: Application: Digital Automixer 4 / 2 / 2 <p3>: OEM Version: 0 (reserved) 2. 2. 2 Hardware Version (, , U2DM<d>HW?<CR>") Dir Telegram U2DM<d>HW?<CR> U2DM1HW?<CR> U2DM<d>SW=<p1>, <p2>, <p3>, <p4>, <p5><CR> Device returns the hardware version/info: <p1>: HW-Version <p2>: FPGA Version VHDL <p3>: FPGA Version MLAB <p4>: S-<card nr> (e. g. : 810 = S810) <p5>: Processor type (reserved) <p1>: HW-Version = 1 <p2>: FPGA Version VHDL = 1 <p3>: FPGA Version MLAB = 2 <p4>: S<card nr> = S830 <p5>: Processor type = 0 (reserved) Description This command requests the actual hardware version/info of the device. U2DM1HW=1, 1, 2, 830, 0<CR> © Stemin GmbH · SDXI U2 Protocol Description V1. 15. doc · page 8 of 15 SDXI-U2 Serial ASCII Data Exchange Interface General Description V1. 15 2. 3 Device Configuration 2. 3. 1 Set Baudrate (, , U2DM<d>COM<c>BD=<bd>") Dir Telegram U2DM<d>COM<c>BD=<bd><CR> Description This command sets the baudrate of the specified COM port of the device: <c> = COM port 0: COM port actually connected to the device 1: COM 1 of the device 2: COM 2 of the device <bd>= Baudrate 24 (=2400 Baud) 48 (=4800 Baud) 96 (=9600 Baud) 192 (=19200 Baud) 384 (=38400 Baud) 576 (=57600 Baud) 1152 (=115200 Baud) Note: these settings can not be changed, they are fix: Parity: no Databits: 8 Stopbit(s): 1 U2DM1COM0BD=1152<CR> <p1>: Baudrate = 1152 (the new device baudrate is set to 115200 Baud) no device response no device response ----- 2. 3. 2 Set Remote Interface (, , U2DM<d>DRI=<s>") Dir Telegram U2DM<d>DRI=<s><CR> Description This command enables or disables the remote interface of the device. <e>: selected encoder Executes a rotate right action at encoder 2 returns the settings of the selected encoder: (see. "Encoder Request Value" command) returns the settings of the encoder 2: <ev> = 27 Executes a rotate left action at encoder 2 returns the settings of the encoder 2: <ev> = 26 Executes a rotate left action at encoder 2 returns the settings of the encoder 2: <ev> = 25 U2DM1EN2RR<CR> U2DM<d>EN<e>=<scs>, <ev>, <mut>, <onl>, <pkl><CR> U2DM1EN2=1, 27, 0, 0, 0<CR> U2DM1EN2RL<CR> U2DM1EN2=1, 26, 0, 0, 0<CR> U2DM1EN2RL<CR> U2DM1EN2=1, 25, 0, 0, 0<CR> 2. 4. 4 Encoder Set Value (, , U2DM<d>EN<e>=<ev><CR>") Dir Telegram U2DM<d>EN<e>=<ev><CR> Description This command sets directly a new value to the encoder <e>: selected encoder <ev>: new encoder value sets encoder 2 to value of 32: <ev> = 32 returns the settings of the selected encoder: (see. "Encoder Request Value" command) returns the settings of the encoder 2: <ev> = 32 sets encoder 7 (=system control) to value 2: <ev> = 2 (Bass) returns the bass settings of all encoder/channels: U2DM1EN2=32<CR> U2DM<d>EN<e>=<scs>, <ev>, <mut>, <onl>, <pkl><CR> U2DM1EN2=1, 32, 0, 0, 0<CR> U2DM1EN7=2<CR> U2DM1EN1=2, -4, 0, 0, 0<CR> U2DM1EN2=2, 0, 0, 0, 0<CR> U2DM1EN3=2, 0, 0, 0, 0<CR> U2DM1EN4=2, 0, 0, 0, 0<CR> U2DM1EN5=2, 0, 0, 0, 0<CR> U2DM1EN6=2, 0, 0, 0, 0<CR> U2DM1EN7=2, 2, 0, 0, 0<CR> U2DM1EN8=2, 0, 0, 0, 0<CR> © Stemin GmbH · SDXI U2 Protocol Description V1. 15. doc · page 11 of 15 SDXI-U2 Serial ASCII Data Exchange Interface General Description V1. 15 2. 5 Status Commands 2. 5. 1 Request Channel Status (, , U2DM<d>CS<c>?<CR>") Dir Telegram U2DM<d>CS<c>?<CR> Description This command requests the status of the selected channel from the device <c>: selected channel Requests the channel status of channel 2 returns the status data of the selected channel <cl>: channel level <mut>: Mute State <onl>: "ON"-LED State <pkl>: "PEAK"-LED State: Device returns the status of channel 2: <cl>: = 6 <mut>: = 0 <onl>: = 1 <pkl>: = 0 U2DM1CS2?<CR> U2DM<d>CS<c>=<cl>, <mut>, <onl>, <pkl><CR> U2DM1CS2=6, 0, 1, 0<CR> 2. 5. 2 Set Channel Status Remote Update Time (, , U2DM<d>CS<c>=<t><CR>") Dir Telegram U2DM<d>CS<c>=<t><CR> Description With this command you can set the time period (= t*100 ms) the device automatically sends a single channel status telegram for each channel: <c>: channel (has no effect) <t>: time period t*100 ms 0 = disables the automatic update 1 . . . 15 U2DM1CS1=5<CR> U2DM<d>CS<c>=<cl>, <mut>, <onl>, <pkl><CR> U2DM1CS1=13, 0, 0, 0<CR> <Delay t*100ms> U2DM1CS2=18, 0, 1, 0<CR> <Delay t*100ms> U2DM1CS3=35, 0, 1, 0<CR> <Delay t*100ms> U2DM1CS4=43, 0, 1, 1<CR> <Delay t*100ms> U2DM1CS5=30, 0, 1, 0<CR> <Delay t*100ms> U2DM1CS6=33, 0, 1, 0<CR> <Delay t*100ms> U2DM1CS7=0, 0, 0, 0<CR> <Delay t*100ms> U2DM1CS8=13, 0, 1, 0<CR> <Delay t*100ms> U2DM1CS1=13, 0, 1, 0<CR> <Delay t*100ms> . . . [. . . ] ON: activates the input channel (Force On) and sets the according logic output pin to high (e. g. OFF: deactivates the input channel (Force Off) and sets the according logic output pin to low (e. g. REQUEST TO SPEAK: deactivates the input channel (Force Off) and flashes the according logic output pin with a frequency of 2 Hz (e. g. [. . . ]