background image

I n s t r u c t i o n   M a n u a l

A M X   A u t o P a t c h   C o m m u n i c a t i o n   P r o t o c o l

BCS

(Basic Control Structure)

Protocol

R E V   J :   0 2 / 0 6 / 2 0 1 3

Summary of Contents for BCS

Page 1: ...Instruction Manual AMX AutoPatch Communication Protocol BCS Basic Control Structure Protocol REV J 02 06 2013 ...

Page 2: ...udio 12 Adjusting Volume 13 Applying Removing Mute to Volume 14 Verifying Volume Status 15 Adjusting Digital Input Gain 16 Verifying Digital Input Gain Status 18 Adjusting and Verifying Audio with DSP 20 General Audio Rules for Products with DSP 20 Adjusting Balance 21 Adjusting Tone 21 Adjusting Equalization Bands 22 Verifying DSP Command Status 23 Appendix A Product Specific BCS Commands 25 Prod...

Page 3: ...or Code Reporting 41 Limited Error Codes Error Code Numbers and Prefixes 41 Enabling Error Code Reporting 42 Common System Error Codes 42 Technical Support 43 Appendix C Programmer s Interface for System Diagnostics 45 System Component Information 45 Using BCS to Access System Diagnostic Information 47 Splash Screen Examples 48 ...

Page 4: ...otocol the AMX AutoPatch CD that ships with each system includes the XNNet Communication Library This interface library supports C Java and Visual Basic and has examples of the XNNet Protocol in use General rules as well as lists and tables for command string formats and command string responses are provided first for quick reference Detailed information and examples for creating and executing the...

Page 5: ...t and highest numbers of the range not supported if the command is otherwise invalid e g cannot specify a range of inputs in a Change command the first input only would be routed Colons and spaces can be used in the same command string If the level designation L is omitted the command is executed on the default level which is normally Level 0 For systems where all of the audio channels are not swi...

Page 6: ...ands 1 Enter commands using the formats from the tables below Replace the s with the appropriate level and input source or output destination number Replace the with the decibel level entered as an integer number representing the desired decibel value multiplied by 10 e g 8 0 dB is entered as 80 and 40 5 dB is entered as 405 Caution We strongly recommend that input gain adjustments be made only by...

Page 7: ...Preset Initiates an Execute Global Preset command by indicating that the number following it is a global preset number Also initiates an Execute Local Preset command when it precedes the level and the local preset character P P Local Preset Indicates the number following is a local preset number RR Define Global Preset Initiates a Define Global Preset command Digital Output Volume and Digital Inpu...

Page 8: ...code number information on Error or Warning responses note the specific number and see Appendix B Error Code Reporting page 41 Command String Response Examples Response Meaning Description Format Error Indicates an error in the command string format or syntax e g not indicating an input in a Change command X General Error Indicates the system rejected all or part of the command e g entering an inv...

Page 9: ...ble responses see page 5 In each Change command you can enter multiple levels and multiple outputs destinations but only one input source To enter multiple levels and outputs include a space between each set of numbers To enter a range of outputs insert a colon between the lowest and highest numbers of the range If the level is not specified in the Change command the command is executed on the def...

Page 10: ...vel 0 e g DO67T disconnects Output 67 on Level 0 Important If the level is not specified in a BCS command the command is executed on the default level normally Level 0 which is defined in the configuration file If the level is omitted and the BCS command executes on an unexpected level check the default level in the configuration file for systems without a configuration file check the product docu...

Page 11: ...ted on the default level which is normally Level 0 e g SI83T verifies the routing status of Input 83 on Level 0 If you check the status for an input or an output on an audio follow video level and only the video or the audio is routed on that level the result will come back as not routed unless the system supports fragmented status reporting Important If the level is not specified in a BCS command...

Page 12: ...t 5 is also routed to Output 10 on the audio level L2 The results of checking status on Input 5 on the audio follow video level L0 would be SL0I5T 9 10 This indicates that Output 9 is connected on all defined components of Input 5 on Level 0 and that Output 10 is connected on some but not all of the components of Input 5 on Level 0 The results of checking the status of Output 10 on the audio follo...

Page 13: ...the AMX AutoPatch CD or at www amx com General Rules for Local Presets Executing a local preset does not change any system routings that are not part of the preset Local presets cannot be used to change any of the audio settings If two local presets are executed in the same command both will be executed If both include routing instructions for the same input or output the input or output will be r...

Page 14: ... preset 1 Route the system to the desired state and enter the Define Global Preset command below Replace the with the global preset number RR T It may take several seconds for the T to appear depending on the type and size of the system Define Global Preset Examples To execute a global preset 1 Enter the Execute Global Preset command below Replace the with the global preset number R T Execute Glob...

Page 15: ...levels as an integer number representing the desired decibel value multiplied by 10 For example 5 dB is entered as 50 and 60 5 dB is entered as 605 Interpret results for a volume status command in the same way Do not use leading zeros for gain values in audio commands When a muted output is un muted the output returns to its previously un muted volume When a Volume command is sent to a muted outpu...

Page 16: ...icating an invalid value was entered for a specific audio board s volume adjustment range see that board s documentation Relative Method The Relative Method adjusts the volume of an output by a specific decibel amount To adjust an output s volume by a specific decibel amount 1 Enter the Volume Relative command below Replace the s with the level and output number s and replace the with the decibel ...

Page 17: ... invalid value was requested for a specific audio board s volume adjustment range see the board s documentaion Applying Removing Mute to Volume Not all systems with audio support the mute option If your system supports the mute option outputs can be muted and un muted using BCS commands Inputs cannot be muted Note For BCS purposes VM refers to volume mute not virtual matrix Applying Mute To mute a...

Page 18: ...status result is M the volume is muted To verify the volume status of a specific output 1 Enter the Verify Volume Status command below Replace the s with the level and output number SL O VT Volume Status Examples BCS Command Action CL0O24VMT Mutes Output 24 on Level 0 CL0O2 4VMT Mutes Outputs 2 and 4 on Level 0 CL0O2 8VMT Mutes Outputs 2 3 4 5 6 7 and 8 on Level 0 CL0O5VUT Unmutes Output 5 on Leve...

Page 19: ...gain the amount of input gain plus the amount of output gain for any input to output routing path is automatically limited by the matrix switcher For the value of through system gain and other audio specifications see your matrix switcher s instruction manual If a volume command is entered that exceeds the matrix switcher s specifications the command will be accepted and will be indicated in statu...

Page 20: ... The Relative Method adjusts digital input gain by a specific decibel amount To adjust digital input gain by a specific decibel amount 1 Enter the Relative command below Replace the s with the level and input number s and replace the with the decibel level entered as a decimal number see General Rules for Audio on page 12 CL I VR T 2 Repeat Step 1 as necessary for additional sources inputs that wi...

Page 21: ...ent the system will respond with an X indicating an invalid value was entered For a specific audio board s input gain adjustment range see the specific board s documentation Verifying Digital Input Gain Status The digital input gain setting will display in parentheses even if the input is not receiving a signal The decibel amount in the result is specified as a decimal number to the tenth place wi...

Page 22: ...Adjusting and Verifying Audio 19 Instruction Manual BCS Basic Control Structure Protocol ...

Page 23: ... not need to be routed to adjust the volume however it may be helpful to hear the adjustment This also applies to adjusting input gain Enter decibel levels as integer numbers representing the desired decibel value multiplied by 10 For example 5 dB is entered as 50 and 60 5 dB is entered as 605 Interpret volume status results in the same way Do not use leading zeros for gain values in audio command...

Page 24: ...justed to a specific decibel level at anytime during normal operations Each tone band has a range of 12 dB to 12 dB Further frequency adjustments can be made to each output by adjusting the equalization bands see page 22 To adjust the gain of a tone band filter for an output 1 Enter the tone command below Replace the s with the output number and tone band filter number and replace with the decibel...

Page 25: ...e bands in the same command an E and a list of the bands is entered first followed by a G and a list of the corresponding gain settings The number of gain settings must be equal to the number of bands To adjust equalization bands for an output 1 Enter the following command string Replace the s with the output number s and equalization band number s and replace the with the decibel level CO E G T E...

Page 26: ... s with the output number SO PT To verify the gain of a tone band for an output 1 Enter the following command string Replace the s with the output number and tone band filter number SO F T To verify the gain of an equalization band for an output 1 Enter the following command string Replace the s with the output number and EQ band SO E T DSP Command Status Examples BCS Command Status Result Explana...

Page 27: ...Adjusting and Verifying Audio with DSP 24 Instruction Manual BCS Basic Control Structure Protocol ...

Page 28: ... and Modula CatPro page 31 Octaire page 32 Optima and Optima SD page 33 Precis DSP page 34 Precis LT page 35 Precis SD page 35 Heritage Systems page 37 1Y Series 4Y DM 8Y DM and 8Y XL 8Y 3000 Precis 6x2 Precis 300 MHz Precis HT Basic Support BCS command characters are listed in the tables on page 4 Basic command string formats are listed in the tables on page 3 All supported enclosures with the ex...

Page 29: ...he scr command to display a splash screen To determine the Application Code version for these systems before applying power attach a PC to the enclosure s serial port with a null modem serial cable Open HyperTerminal or other terminal emulation program on the PC and power up the system View the display in HyperTerminal for system information including the Application Code version To determine the ...

Page 30: ...command Specific Commands The Enova DGX 8 16 3232 supports fragmented status reporting see page 9 and error code reporting see page 41 Diagnostic Commands The Enova DGX 8 16 32 displays system information in the splash screen for diagnostic purposes The information indicates the current status and well being for some of the system components For information on system diagnostics that includes the ...

Page 31: ...olume control If the Epica 128 or Epica 256 supports digital control of audio signals it supports the following audio commands Digital output volume control absolute relative and increment decrement methods see page 13 Verifying volume status see page 15 Muting and un muting outputs see page 14 Digital input gain control absolute relative and increment decrement methods see page 16 Verifying digit...

Page 32: ...ode reporting see page 41 Diagnostic Commands The Epica DG Epica DGX 16 Epica DGX 32 and Epica DGX 144 display system information in the splash screen for diagnostic purposes The information indicates the current status and well being for some of the system components For information on system diagnostics that includes the commands and applies to all systems that support diagnostic commands see pa...

Page 33: ...h screen for diagnostic purposes The information indicates the current status and well being for some of the system components For information on system diagnostics that includes the commands and applies to all systems that support diagnostic commands see page 45 Component Settings The HDMI UTPro supports the 6 component identity number settings i0 through i5 in the following table Tip The informa...

Page 34: ... see page 13 Verifying volume status see page 15 Muting and un muting outputs see page 14 Digital input gain control absolute relative and increment decrement methods see page 16 Verifying digital input gain status see page 18 Specific Commands and Conditions Modula and Modula CatPro models with Application Code v 2 6 0 or later support fragmented status reporting see page 9 Modula and Modula CatP...

Page 35: ...tions When entering commands use L0 or omit level for routing the All level audio follow video L1 for routing the Video level and L2 for routing the Audio level Does not support local preset commands Diagnostic Commands The Octaire displays system information in its splash screen for diagnostic purposes The information indicates the current status and well being for some of the system components F...

Page 36: ... or later support fragmented status reporting see page 9 Diagnostic Commands Optima and Optima SD models display system information in their splash screens for diagnostic purposes The information indicates the current status and well being for some of the system components For information on system diagnostics that includes the commands and applies to all systems that support diagnostic commands s...

Page 37: ...Verifying volume status see page 15 Muting and un muting outputs see page 14 Digital input gain control absolute relative and increment decrement methods see page 16 Verifying digital input gain status see page 18 Diagnostic Commands Precis DSP models display system information in their splash screens for diagnostic purposes The information indicates the current status and well being for some of t...

Page 38: ...SD Note This section also applies to any Precis 500 MHz models built before the Precis SD was released Precis SD models support the following items General Commands and Conditions Executing and disconnecting switches see page 6 and page 7 Verifying signal status see page 8 Executing local presets predefined in XNConnect see page 10 this product supports 64 local presets Defining and executing glob...

Page 39: ...ands The Precis SD displays system information on the splash screen for diagnostic purposes The information indicates the current status and well being for some of the system components For information on system diagnostics that includes the commands and applies to all systems that support diagnostic commands see page 45 Component Settings The Precis SD supports six component identity number setti...

Page 40: ...mmand string contains the characters or x instead of the characters you entered re enter the command with all capital letters BCS commands can be used to program and change the configuration word on some heritage systems The configuration word is a hexadecimal number that tells the matrix how to set the baud rate choose the number of SBCs to poll and whether or not to echo serial commands on the c...

Page 41: ...nd Conditions If the Level L designation is omitted the command is executed on the default level which is Level 0 audio follow video To route video or audio signals separately enter Level 1 for video only or Level 2 for audio only The Precis 6x2 with a front control panel will accept BCS commands while the panel is locked but BCS commands cannot be used to unlock the front panel The Precis 6x2 is ...

Page 42: ...rement decrement methods see page 13 Verifying volume status see page 15 Digital input gain control absolute relative and increment decrement methods see page 16 Verifying digital input gain status see page 18 Precis HT Precis HT models support the following items General Commands and Conditions Executing and disconnecting switches see page 6 and page 7 Verifying signal status see page 8 Executing...

Page 43: ...Appendix A Product Specific BCS Commands 40 Instruction Manual BCS Basic Control Structure Protocol ...

Page 44: ...n the CPU and the control panel Troubleshooting When error code reporting is enabled error codes can appear in a terminal emulation program such as HyperTerminal When you are using BCS commands one common troubleshooting strategy is to enter the command again Often the command has simply been entered incorrectly e g omitting an output in a Change command In other cases the command has specified a ...

Page 45: ...stem did not acknowledge a control operation command Resend the command Check the Status LED on the rear of each enclosure If any of the LEDs are red contact technical support Check the power indicators Check the link connectors between enclosures EFF8002 Transaction timeout error The operation was not completed before the timer expired Resend the command Check the power indicators Check the link ...

Page 46: ...e contact your AMX representative or technical support Have the system s serial number ready The system s serial number is normally located on the rear of the enclosure We recommend recording the system s serial number in an easily accessible location AMX Contact Information 3000 Research Drive Richardson TX 75082 800 222 0193 469 624 8000 Fax 469 624 7153 Technical Support 800 932 6993 www amx co...

Page 47: ...Appendix B Error Code Reporting 44 Instruction Manual BCS Basic Control Structure Protocol ...

Page 48: ...e entered in a command The order in which the verbosity and component identity settings are entered is interchangeable For the number of components a system supports see the individual product in Appendix A Product Specific BCS Commands starting on page 25 Note In a multi enclosure system the splash screen displays information only for the enclosure that is connected directly to the PC AMX reserve...

Page 49: ... by using the identity number i0 Note For the number of components that individual products support see Appendix A Product Specific BCS Commands on page 25 Default Settings At system boot the scrv0i1 setting is displayed If the verbosity setting is omitted the verbosity level will be the lowest v0 The component setting must be included otherwise entering any of the verbosity settings alone will re...

Page 50: ...and The order in which the verbosity and component identity settings are entered is interchangeable To access a specific level of verbosity for a specific component 1 Enter scr to access the splash screen 2 Enter the verbosity level setting v and the component s identity setting i Either may be specified first 3 Enter to send the command Diagnostic Command Examples Diagnostic Commands for Products...

Page 51: ...i7 verbosity 3 component 7 FIG 5 Display for v3i6 verbosity 3 component 6 scrv1i7 7 System Sensors detected cpu pol detected io board 5 sensors detected center board 1 sensors detected center board 2 sensors detected fan controller 1 detected fan controller 2 detected scrv3i7 7 System Sensors detected cpu pol detected temp 51c io board 5 sensors detected temp 1 32 3c temp 2 33 9c center board 1 se...

Page 52: ...plash Screen Examples continued FIG 6 Display for v3i4 verbosity 3 component 4 scrv3i4 4 Hardware Boards detected switching drivers count 4 mtx driver 1 M21151 144 x 144 driver revision code 0x4 product code 0xc0 mtx driver 2 M21151 144x144 driver revision code 0x4 product code 0xc0 mtx driver 3 M21151 144x144 driver ...

Page 53: ...cation knowledge In the ever changing AV industry continual education is key to success AMX University is dedicated to ensuring that you have the opportunity to gather the information and experience you need to deliver strong AMX solutions Plus AMX courses also help you earn CEDIA NSCA InfoComm and AMX continuing education units CEUs Visit AMX University online for 24 7 365 access to Schedules and...

Reviews: