User manual BIAMP DRC 4 4 RS-232

[. . . ] Computer Control of the Advantage DRC 4+4 _______________________________________________________________________________________ _ Biamp Systems, 14130 N. W. (503) 641-7287 an affiliate of Rauland-Borg Corp. Introduction This document contains technical information relating to computer control of the Biamp Advantage DRC 4+4 Digital Remote Control. This information is intended for advanced users - in particular for those who wish to develop their own computer programs to control the DRC 4+4. It is assumed that the reader is an experienced programmer and has some familiarity with standard programming practices, binary and hexadecimal numbers, the ASCII character set, asynchronous serial data communications, and RS-232 interfaces. Hexadecimal, ASCII-Hex, and "Pseudo-Hex" Numbers Throughout this document, hexadecimal numbers shall be represented by preceding the number with "0x". [. . . ] Each button definition data structure consists of five bytes (which are transmitted as 10 pseudo-hex characters). These five bytes indicate all of the preset, volume, and logic actions which are assigned to a particular button. DRC 4+4 Button Definition Data Structure 5-byte array with elements numbered button[0] thru button[4] (msb) 7 6 5 4 3 2 1 (lsb) 0 LOGIC OUTPUT ACTIONS button[4] (transmitted first) LOGIC 4 LOGIC 3 button[3] button[2] button[1] button[0] (transmitted last) LOGIC 2 LOGIC 1 VCA 8 VCA 7 VCA 6 VCA 5 VOLUME ACTIONS VCA 4 VCA 3 VCA 2 VCA 1 0 0 ACTION CODE 0 PRESET NUMBER PRESET ACTION Logic Output Action Codes 1111 1110 1101 1100 1011 1010 1001 1000 0111 0110 0101 0100 0011 0010 0001 0000 (reserved) (reserved) (reserved) single pulse 2 1/2 seconds single pulse 1 second single pulse 1/2 second single pulse 1/4 second single pulse 1/5 second single pulse 1/10 second single pulse 1/20 second repeating pulse 1/20 second pushbutton/momentary on toggle/filp-flop turn on turn off NOP (no operation) Volume Action Codes 11 10 01 00 toggle mute volume up volume down NOP (no operation) Preset Action Codes 11 10 01 00 (reserved) store preset recall preset NOP (no operation) 2-Nov-06 Computer Control of the Advantage DRC 4+4 page 9 Advanced Computer Control Command Notation For the following descriptions of the Advanced Computer Control command set, the following conventions will be used. Each ASCII character which represents a pseudohex nibble will be shown in italics, with the following letters representing certain types of parameters: b d l m n p v x one of the pseudo-hex nibbles occurring in the button definition data structure. one of the pseudo-hex nibbles in the device number bitmask which indicates which device numbers should accept the following command. one of the pseudo-hex nibbles occurring in the preset mix data structure. a pseudo hex nibble specifying a button, logic output, VCA channel, or preset mix number. a pseudo-hex nibble specifying a generic data value. page 10 Computer Control of the Advantage DRC 4+4 2-Nov-06 ! virtual-button Description: The virtual-button command causes the specified preset, volume, and logic output actions to be immediately performed. The button definition is not stored in the DRC 4+4's nonvolatile memory, nor is the button definition associated with a button number. Normally, when the DRC 4+4 receives a control button command, it looks-up the control button definition for that button number in its control button definition table and then performs the actions defined for that button. The virtual-button command allows the computer to specify the actions to be performed without having the DRC 4+4 look-up an entry in its control button definition table. This command essentially provides the DRC 4+4 (when under computer control) with an unlimited number of button definitions. Syntax of Command: bbbbbbbbbb01dd! where: bbbbbbbbbb 01 dd ! Syntax of Response: = = = = Button Definition Data Structure (pseudo-hex) Device Type Bitmask (pseudo-hex) Device Number Bitmask (pseudo-hex) virtual-button command character (0x21) (no response) Example: :002?000130105!This example causes DRC 4+4 numbers 1 and 3 to both immediately recall preset mix number 3, toggle the mute status for VCA channels 7 and 8, turn on logic output number 1, and activate a 1/2 second pulse on logic output number 4. Comments: 2-Nov-06 Computer Control of the Advantage DRC 4+4 page 11 " get-button-definition Description: The get-button-definition command causes the DRC 4+4 to return the definition of the specified button. The button definition will be returned in the Button Definition Data Structure format. Syntax of Command: nn01dd" where: nn 01 dd " Syntax of Response: = = = = Button Number (pseudo-hex) Device Type Bitmask (pseudo-hex) Device Number Bitmask (pseudo-hex) get-button-definition command character (0x22) bbbbbbbbbb where: bbbbbbbbbb Example: = Button Definition Data Structure (pseudo-hex) command: 1;0101" response: :002?00013 This example causes DRC 4+4 number 1 to retrieve its button definition for control button number 27 (0x1B) and return it to the computer. In this example, the button definition was: recall mix number 3, toggle the mute status for VCA channels 7 and 8, turn on logic output number 1, and activate a 1/2 second pulse on logic output number 4. Comments: Button number must be 00 to 40 (0x00 to 0x28), otherwise the command will be ignored. page 12 Computer Control of the Advantage DRC 4+4 2-Nov-06 # define-button Description: The define-button command provides a new definition for the specified button number. The DRC 4+4 will store this new button definition in its control button definition lookup table, replacing the definition that was there. Syntax of Command: bbbbbbbbbbnn01dd# where: bbbbbbbbbb nn 01 dd # Syntax of Response: = = = = = Button Definition Data Structure (pseudo-hex) Button Number (pseudo-hex) Device Type Bitmask (pseudo-hex) Device Number Bitmask (pseudo-hex) define-button command character (0x23) (no response) Example: 0502?00013140108# This example causes DRC 4+4 number 4 to redefine button number 20 (0x14) to recall preset mix number 3, toggle the mute status for VCA channels 7 and 8, turn on logic output number 1, and activate a 1/20 second pulse on logic output number 3. Comments: Button number must be 00 to 40 (0x00 to 0x28), otherwise the command will be ignored. 2-Nov-06 Computer Control of the Advantage DRC 4+4 page 13 $ do-button Description: The do-button command causes the DRC 4+4 to look-up and perform the actions for the specified button number. Syntax of Command: nn01dd$ where: nn 01 dd $ Syntax of Response: = = = = Button Number (pseudo-hex) Device Type Bitmask (pseudo-hex) Device Number Bitmask (pseudo-hex) do-button command character (0x24) (no response) Example: 28010?$ This example causes DRC 4+4 numbers 1, 2, 3, and 4 to look-up and perform the actions defined in their respective control button definition tables for button number 40 (0x28). Comments: Button number must be 01 to 40 (0x01 to 0x28), otherwise the command will be ignored. page 14 Computer Control of the Advantage DRC 4+4 2-Nov-06 % get-preset-mix-settings Description: The get-preset-mix-settings command causes the DRC 4+4 to return the settings of the specified preset mix. The preset mix settings will be returned in the Preset Mix Data Structure format. Mix 00 is the power-up mix (which is the periodically-stored current mix). Mix 05 is the current mix. Syntax of Command: nn01dd% where: nn 01 dd % Syntax of Response: = = = = Preset Mix Number (pseudo-hex) Device Type Bitmask (pseudo-hex) Device Number Bitmask (pseudo-hex) get-preset-mix-settings command character (0x25) mmmmmmmmmmmmmmmmmm where: mmmmmmmmmmmmmmmmmm = Preset Mix Data Structure (pseudo-hex) Example: command: 020101% response: 003?3?000000000000 This example causes DRC 4+4 number 1 to retrieve its settings for preset mix number 2. In this example, preset mix number 2 was defined with all logic outputs off, VCA channels 7 and 8 at maximum volume, and VCA channels 1 through 6 at minimum volume. Comments: The preset mix number must be in the range of 00 through 05. 2-Nov-06 Computer Control of the Advantage DRC 4+4 page 15 & define-preset-mix Description: The define-preset-mix command provides a new definition for the specified preset mix. Preset mix 00 is the power-up mix (which is the periodically-stored current mix). If either preset mix 05 or 06 is specified, the mix definition immediately becomes active. If preset mix 05 is specified, the DRC 4+4 will save the current mix as the power-up mix after 5 seconds of inactivity. [. . . ] 0x76 define preset nibble 0x6 button 05 button 21 button 36 select 1, 2, 4 0x17 039. 0x77 do preset nibble 0x7 button 06 button 22 button 37 select 3, 4 0x18 040. 0x78 do volume nibble 0x8 button 07 button 23 button 38 select 1, 3, 4 0x19 041. 0x79 do logic nibble 0x9 button 08 button 24 button 39 select 2, 3, 4 0x1A 042. [. . . ]