Certifiedc4:av_genCopyright 2011 Avocation Systems, Inc. All rights reserved.Avocation Systems0400BMC06/07/2011 10:17:00 AM07/25/2011 10:23:00 AMMX-0404NAD/R [Serial][DriverWorks]devices_sm/KnoxRS8x8HB.GIFdevices_lg/KnoxRS8x8HB.GIFAvocation Systems MX-0404NAD/R v4.00lua_genavswitchavswitchavswitchavswitchavswitchDriverWorksControl4 certified on 8/24/2011 for software released versions: 2.1.0 Avocation Systems, Copyright 2011. Version 04.00 This driver is written for the MX series matrices. INSTALLATION NOTE: When installing this driver for the first time you need to execute the "Read Max Volume for All Outputs" action in the "Actions" tab. Before executing this action, make sure that the Matrix is connected to the Controller AND that there is a binding between a serial port on the Controller and the serial port on the Matrix. The "Read Max Volume for All Outputs" action will cause the Control4 system to read from the Matrix the Maximum Volume setting for each output. This is important for the correct display of the volume percentage for each output. After executing this action, the driver will periodically request from the Matrix the Maximum Volume setting for each output. This section describes the functionality of the Properties and Actions. See below for GENERAL INFORMATION. PROPERTIES: Debug Mode -> This property configures how textual debug information is displayed. -- "Off" means that no debug information is displayed. -- "Print" means that the debug information is displayed in the Lua Output window of the Lua tab in Composer. -- "Log" means that the debug information is displyed in the Error Log file for the next 15 minutes. After 15 minutes this property reverts to "Print". -- "Print and Log" means that the debug information is displayed in both the Lua Output window and the Error Log file for 15 minutes. After 15 minutes this property reverts to "Print". -- The default value of this property is "Print". -- If the Debug Mode is set to "Off", then the setting of the Debug Level is irrelevant. Debug Level -> This property configures what textual debug information is reported. -- "Matrix Comm" is the lowest debug level and "Verbose" is the highest. All data from the selected debug level and lower debug levels will be reported. -- Error debug messages will always be reported, regardless of the Debug Level setting, if Debug Mode is not set to "Off". -- "Matrix Comm" means that data sent to or received from the Matrix is reported. -- "C4 Comm" means that data sent to or received from the Control4 Proxy is reported, along with messages at the "Matrix Comm" level. -- "Warnings" means that messages about abnormal operation of this driver are reported, along with messages at the "C4 Comm" level and below. -- "Info" means that messages from some of the operation of this driver are reported, along with messages at the "Warnings" level and below. -- "Verbose" means that messages from all of the operation of this driver are reported, along with messages at the "Info" level and below. -- The default value of this property is "C4 Comm". -- The Debug Level setting is only relevant if the Debug Mode is set to anything but "Off". Command Delay-Milliseconds -> This property sets the time interval between successive commands sent to the Matrix. -- The range of values for this property is 50 ms to 2500 ms (2.5 s). -- The default value of this property is 250 ms. Volume Ramp Delay-Milliseconds -> This property sets the time interval between successive Volume commands sent to the Matrix when the Volume Ramping functionality is active. -- The Volume Ramping functionality is activated by a START_VOL_UP or START_VOL_DOWN command from the Proxy and is deactivated by a STOP_VOL_UP or STOP_VOL_DOWN command. -- The range of values for this property is 50 ms to 500 ms (0.5 s). -- The default value of this property is 250 ms. Unit Address -> This property sets the two digit ID Code that is used to identify which Matrix is the intended recipient of the commands sent by this driver. -- The ID Code of the Matrix is set by the DIP switches inside the Matrix. -- The range of values for this property is "00" to "15". -- The default value of this property is "00". Front Panel Enabled -> This property is used to configure the Front Panel Controls of the Matrix. -- "True" means that the Front Panel Controls are Enabled. -- "False" means that the Front Panel Controls are Disabled. -- The default value of this property is "True". Analog Audio Input To All Outputs -> This property is used to instruct the Matrix to route the selected Analog Audio Input to all Analog Audio Outputs. -- The range of values for this property is 1 to 4. -- The default value of this property is 1. Video Input To All Outputs -> This property is used to instruct the Matrix to route the selected Video Input to all Video Outputs. -- The range of values for this property is 1 to 4. -- The default value of this property is 1. Digital Audio Input To All Outputs -> This property is used to instruct the Matrix to route the selected Digital Audio Input to all Digital Audio Outputs. -- The range of values for this property is 1 to 4. -- The default value of this property is 1. Composite Video Input To All Outputs -> This property is used to instruct the Matrix to route the selected Composite Video Input to all Composite Video Outputs. -- The range of values for this property is 1 to 4. -- The default value of this property is 1. Balance To All Outputs -> This property is used to instruct the Matrix to set the Balance Level for all Audio Outputs. -- The range of values for this property is 1 to 100. -- The default value of this property is 50. -- NOTE: The Balance Level displayed on the Front Panel of the Matrix will be one less than the value set here. Sensitivity To All Inputs -> This property is used to instruct the Matrix to set the Sensitivity Level for all Audio Inputs. -- The range of values for this property is 0 to 32. -- The default value of this property is 32. This corresponds to a 0 dB gain. Volume To All Outputs -> This property is used to instruct the Matrix to set the Volume Level for all Audio Outputs. -- The range of values for this property is 1 to 49. -- The default value of this property is 33. This corresponds to a 0 dB gain. -- NOTE: The Volume Level displayed on the Front Panel of the Matrix will be one less than the value set here. Route Digital Audio With Analog Audio -- "True" means that the Digital Audio will route with the Analog Audio. -- "False" means that the Digital Audio will not route with the Analog Audio. -- The default value of this property is "False" Route Digital Audio With Video -- "True" means that the Digital Audio will route with the Video. -- "False" means that the Digital Audio will not route with the Video. -- The default value of this property is "False" Route Composite Video With Analog Audio -- "True" means that the Composite Video will route with the Analog Audio. -- "False" means that the Composite Video will not route with the Analog Audio. -- The default value of this property is "False" Route Composite Video With Video -- "True" means that the Composite Video will route with the Video. -- "False" means that the Composite Video will not route with the Video. -- The default value of this property is "False" Alternate Startup Mode -> This property is used to configure the Startup Mode of the Matrix. -- "True" means that upon Startup the Matrix will NOT restore any routes and the Audio Output Volumes will be set to the defined Startup Volume Levels. -- "False" means that upon Startup the Matrix will restore all routes and set the Audio Output Volumes to their previously set Volume Levels. -- The default value of this property is "False" Input XX Sensitivity -> These properties are used to instruct the Matrix to set the Sensitivity Level for Audio Input XX. -- The range of values for this property is 0 to 32. -- The default value of this property is 32. This corresponds to a 0 dB gain. Output XX Max Volume -> These properties are used to instruct the Matrix to set the Maximum Volume Level for Audio Output XX. -- The range of values for this property is 1 to 49. -- The default value of this property is 33. This corresponds to a 0 dB gain. -- NOTE: The Volume Level displayed on the Front Panel of the Matrix will be one less than the value set here. Output XX Volume Lock-> These properties are used to instruct the Matrix to lock the Volume Control for Audio Output XX. -- "True" means that the Volume Control for Audio Output XX is locked, i.e. the volume CAN'T be changed. -- "False" means that the Volume Control for Audio Output XX is unlocked, i.e. the volume CAN be changed. -- The default value of this property is "False" Output XX Startup Volume -> These properties are used to instruct the Matrix to set the Startup Volume Level for Audio Output XX. -- The range of values for this property is 1 to 49. -- The default value of this property is 33. This corresponds to a 0 dB gain. -- NOTE: The Volume Level displayed on the Front Panel of the Matrix will be one less than the value set here. ACTIONS: Read Max Volume for All Outputs -> This action will ask the Matrix to output the current Maximum Volume Level for each Audio Output. This action will update the values of the "Output XX Max Volume" properties. Read Route Digital with Audio or Video -> This action will ask the Matrix to output the current status of the Route Digital Audio/Composite Video with Audio/Video functionality. This action will updte the values of the "Route Digital Audio With Analog Audio", "Route Digital Audio With Video", "Route Composite Video With Analog Audio" and "Route Composite Video With Video" properties. Read Sensitivity for All Inputs -> This action will ask the Matrix to output the current Sensitivity Level for each Audio Input. This action will update the values of the "Input XX Sensitivity" properties. Read Front Panel Status -> This action will ask the Matrix to output the current status of the Front Panel usage. This action will update the value of the "Front Panel Enabled" property. Read Startup Volume for All Outputs -> This action will ask the Matrix to output the Startup Volume Level for each Audio Output. This action will update the values of the "Output XX Startup Volume" properties. Read Volume Lock for All Outpus -> This action will ask the Matrix to output the current Output Volume Lock setting for each Audio Output. This action will update the values of the "Output XX Volume Lock" properties. Read Startup Mode -> This action will ask the Matrix to output the current Startup Mode. This action will update the value of the "Alternate Startup Mode" property. All Outputs to 1 Volume -> This action will instruct the Matrix to set the Volume Level for all Audio Outputs to 1. All Outputs to 0dB Volume -> This action will instruct the Matrix to set the Volume Level for all Audio Outputs to 33 (0 dB). All Inputs to 0dB Sensitivity -> This action will instruct the Matrix to set the Sensitivity Level of all Audio Inputs to 32 (0 dB). Enable Audio Controls -> This action will Enable the control of Output Volume and Input Sensitivity. This Enables control by both the Control4 system and the Front Panel of the Matrix. This action does not change the Output Volume level for any outputs, nor does it change the Input Sensitivity level for any inputs. Disable Audio Controls -> This action will Disable the control of Output Volume and Input Sensitivity. This Disables control by both the Control4 system and the Front Panel of the Matrix. This action does not change the Output Volume level for any outputs, nor does it change the Input Sensitivity level for any inputs. Send Soft Reset -> This action will send the Soft Reset command to the Matrix. Destroy All Timers -> This action kills all timers that are running for this driver. GENERAL INFORMATION: In addition to the functionality of the Properties and Actions noted above, this driver implements the following controls: Volume Controls: -- PULSE_VOL_UP -- PULSE_VOL_DOWN -- START_VOL_UP -- STOP_VOL_UP -- START_VOL_DOWN -- START_VOL_DOWN -- SET_VOLUME_LEVEL -- MUTE_TOGGLE -- MUTE_ON -- MUTE_OFF Balance Controls: -- SET_BALANCE Routing Controls: -- SET_INPUT -- DISCONNECT_OUTPUT END OF DOCUMENTATIONDebug ModeLISTOffPrintLogPrint and LogPrintfalseDebug LevelLISTMatrix CommC4 CommWarningsInfoVerboseC4 CommfalseCommand Delay-MillisecondsRANGED_INTEGER502500250falseVolume Ramp Delay-MillisecondsRANGED_INTEGER50500250falseUnit AddressSTRING00falseFront Panel EnabledLISTTrueFalseTruefalseAnalog Audio Input To All OutputsRANGED_INTEGER141falseVideo Input To All OutputsRANGED_INTEGER141falseDigital Audio Input To All OutputsRANGED_INTEGER141falseComposite Video Input To All OutputsRANGED_INTEGER141falseBalance To All OutputsRANGED_INTEGER110050falseSensitivity To All InputsRANGED_INTEGER03232falseVolume To All OutputsRANGED_INTEGER14933falseRoute Digital Audio With Analog AudioLISTTrueFalseFalsefalseRoute Digital Audio With VideoLISTTrueFalseFalsefalseRoute Composite Video With Analog AudioLISTTrueFalseFalsefalseRoute Composite Video With VideoLISTTrueFalseFalsefalseAlternate Startup ModeLISTTrueFalseFalsefalseInput 01 SensitivityRANGED_INTEGER03232falseInput 02 SensitivityRANGED_INTEGER03232falseInput 03 SensitivityRANGED_INTEGER03232falseInput 04 SensitivityRANGED_INTEGER03232falseOutput 01 Max VolumeRANGED_INTEGER14933falseOutput 02 Max VolumeRANGED_INTEGER14933falseOutput 03 Max VolumeRANGED_INTEGER14933falseOutput 04 Max VolumeRANGED_INTEGER14933falseOutput 01 Volume LockLISTTrueFalseFalsefalseOutput 02 Volume LockLISTTrueFalseFalsefalseOutput 03 Volume LockLISTTrueFalseFalsefalseOutput 04 Volume LockLISTTrueFalseFalsefalseOutput 01 Startup VolumeRANGED_INTEGER14933falseOutput 02 Startup VolumeRANGED_INTEGER14933falseOutput 03 Startup VolumeRANGED_INTEGER14933falseOutput 04 Startup VolumeRANGED_INTEGER14933falseDestroy All TimersDestroy TimersSend Soft ResetSend Soft ResetDisable Audio ControlsDisable Audio ControlsEnable Audio ControlsEnable Audio ControlsAll Inputs to 0dB SensitivityAll Inputs to 0dB SensitivityAll Outputs to 0dB VolumeAll Outputs to 0dB VolumeAll Outputs to 1 VolumeAll Outputs to 1 VolumeRead Startup ModeRead Startup ModeRead Volume Lock for All OutputsRead Volume Lock for All OutputsRead Startup Volume for All OutputsRead Startup Volume for All OutputsRead Front Panel StatusRead Front Panel StatusRead Sensitivity for All InputsRead Sensitivity for All InputsRead Route Digital With Audio or VideoRead Route Digital With XRead Max Volume for All OutputsRead Max Volume for All OutputsAlwaysOn00False19200 8 none 1 none 232Control4 certified on 8/24/2011 for software released versions: 2.1.0This driver uses AlwaysOn power managenment.Up/Down Balance Control, Up/Down Bass Control, Up/Down Treble Control, Toggle Loudness Control80%90%50016AVSWITCH2FalseFalseAVSWITCH50026AVSWITCH2FalseFalseAVSWITCH50036AVSWITCH2FalseFalseAVSWITCH50046AVSWITCH2FalseFalseAVSWITCH16Serial RS-2321TrueTrueRS_23240016OUTPUT016FalseTrueSTEREO20016OUTPUT015FalseTrueCOMPONENT40516OUTPUT016FalseTrueDIGITAL_COAX20516OUTPUT015FalseTrueCOMPOSITE70016Room Selection - OUTPUT017FalseTrueAUDIO_SELECTIONAUDIO_VOLUME70516Room Selection - OUTPUT017FalseTrueVIDEO_SELECTION71016Room Selection - OUTPUT017FalseTrueAUDIO_SELECTION71516Room Selection - OUTPUT017FalseTrueVIDEO_SELECTION40026OUTPUT026FalseTrueSTEREO20026OUTPUT025FalseTrueCOMPONENT40526OUTPUT026FalseTrueDIGITAL_COAX20526OUTPUT025FalseTrueCOMPOSITE70026Room Selection - OUTPUT027FalseTrueAUDIO_SELECTIONAUDIO_VOLUME70526Room Selection - OUTPUT027FalseTrueVIDEO_SELECTION71026Room Selection - OUTPUT027FalseTrueAUDIO_SELECTION71526Room Selection - OUTPUT027FalseTrueVIDEO_SELECTION40036OUTPUT036FalseTrueSTEREO20036OUTPUT035FalseTrueCOMPONENT40536OUTPUT036FalseTrueDIGITAL_COAX20536OUTPUT035FalseTrueCOMPOSITE70036Room Selection - OUTPUT037FalseTrueAUDIO_SELECTIONAUDIO_VOLUME70536Room Selection - OUTPUT037FalseTrueVIDEO_SELECTION71036Room Selection - OUTPUT037FalseTrueAUDIO_SELECTION71536Room Selection - OUTPUT037FalseTrueVIDEO_SELECTION40046OUTPUT046FalseTrueSTEREO20046OUTPUT045FalseTrueCOMPONENT40546OUTPUT046FalseTrueDIGITAL_COAX20546OUTPUT045FalseTrueCOMPOSITE70046Room Selection - OUTPUT047FalseTrueAUDIO_SELECTIONAUDIO_VOLUME70546Room Selection - OUTPUT047FalseTrueVIDEO_SELECTION71046Room Selection - OUTPUT047FalseTrueAUDIO_SELECTION71546Room Selection - OUTPUT047FalseTrueVIDEO_SELECTION30016INPUT016TrueTrueSTEREO10016INPUT015TrueTrueCOMPONENT30516INPUT016TrueTrueDIGITAL_COAX10516INPUT015TrueTrueCOMPOSITE30026INPUT026TrueTrueSTEREO10026INPUT025TrueTrueCOMPONENT30526INPUT026TrueTrueDIGITAL_COAX10526INPUT025TrueTrueCOMPOSITE30036INPUT036TrueTrueSTEREO10036INPUT035TrueTrueCOMPONENT30536INPUT036TrueTrueDIGITAL_COAX10536INPUT035TrueTrueCOMPOSITE30046INPUT046TrueTrueSTEREO10046INPUT045TrueTrueCOMPONENT30546INPUT046TrueTrueDIGITAL_COAX10546INPUT045TrueTrueCOMPOSITETrue4444FalseFalseTrueTrueTrueTrueTrueTrueFalseserial