Home

HAL Crestron Control Systems Guide

1. e Make sure the PC and controller are on the same network and have compatible IP addresses e Make sure the IP address configured for the HAL1x in the controller is the IP address of the PC run ning Halogen and that the port is 4996 e Ensure that the firewall on the PC allows TCP IP communication on port 4996 If the controller connects to the Halogen Control Server but the controls do not operate as expected e Make sure you have applied the configuration to the HAL1x ControlSystemSample hal You can also do this by connecting to your HALIx then loading the example configuration e Use a telnet client to monitor and exercise the external control messages See Appendix B Using PuTTY to Test External Control Systems on page 59 APPENDIX A HAL External Control Message Protocol Once you have connected to either the Halogen or HAL external control server you can communicate with it using simple text based messages This section defines this message protocol All messages consist of ASCII text and a single message always starts with a lt character and ends with a gt char acter Inside the start and end characters is the message body which always includes at least a message type fol lowed by a control number Each part of the message body is separated from another part by an amp character Messages can also have additional parts depending on the type of message The table below shows the format for each specific
2. l Send this to HAL to request the current number of selec tions for Select external con trol It is not meaningful to send this message to HAL because an external control system can not change a selection link in response to a get selection message whenever a Select external control changes value HAL sends this l in response to a get selection link mes sage whenever the link activation changes for the Select exter nal control lt S amp 6 gt request the current value of Select external control number 6 lt S amp 6 amp 3 gt set the value of Select external control number 6 to 3 the fourth item in the set of selections lt SL amp 7 gt get the number of selections for Select external control number E lt SL amp 7 amp 4 gt set the number of selections for Select external control number 7 to 4 54 ANE CRESTRON CONTROL SYSTEMS GUIDE lt SN amp n amp i gt lt SN amp n amp v amp string gt lt SA amp n gt 55 Get selection name message where 1 nis the control number 2 iis the selection item The range for 1 is 0 to one less than the number of selections Set selection name message where n is the control number v is the control value The range for v is 0 to one less than the number of selections string is the current display name for selection v Get label message where n is the control number Send
3. The guide concludes with a troubleshooting section that covers the most common problems encountered when con figuring a target system for the examples Checklist To use the files from the Crestron Support Package and follow along with the examples you will need e A Windows desktop or laptop with an Ethernet port and the latest Rane Halogen 1 1 0 or higher and Cres tron SIMPL Windows and Vision Tools Pro e software installed e A Crestron controller with Ethernet The example project is configured for an MC2E but you can replace this with another Crestron Ethernet controller e An Ethernet switch and cables for the PC and controller Although you will ultimately connect a HAL to your control system all of the integration and testing can be accomplished without a HAL This guide assumes that the reader has had some exposure to Crestron programming and is able to navigate the Crestron software A typical workflow for developing a Crestron application 1s e Configure your Crestron controller touch panel s and TCP IP connections to other devices in the SIMPL Win dows Configuration Manager e Add logic symbols to the SIMPL Windows Program View and name their signals so that the routing results in the desired program e Compile the program and transfer it to your controller e Draw a custom touch panel user interface in Vision Tool Pro e e Join button and slider numbers in the user interface with digital and analog inputs and outpu
4. s radio buttons Double click one of the two Interlock symbols under Logic in the Program View to bring up its details An Inter lock latches an output signal high on the rising edge of its input while forcing all the other outputs low The last input to go high determines which output gets latched high An Interlock is the simplest way to achieve mutual exclusion needed for a group of selector radio buttons Bl 5 8 Interlock CLASSICAL sel JAZZ sal REGGAE sel ea REGGAE sel fb Take the source selector s Interlock for example It handles the CLASSICAL sel JAZZ sel and REGGAE sel sig nals from the Serial I O When the REGGAE sel signal goes high the REGGAE sel fb signal gets latched high and the CLASSICAL sel fb and JAZZ sel fb signals are latched low The end result is that the Reggae radio but ton on the XPanel is activated and the Classical and Jazz radio buttons are deactivated Source Selector This example demonstrates how to get radio buttons on a touch panel to switch between input source selections on a HAL The example Halogen configuration file contains a selector block wired to three HAL mic line Inputs The input nodes on the selector block are named Classical Jazz and Reggae for the genre of music being fed into each of them This selector block is linked to a HAL Control Systems selector control named Source Selector Con trol Switching selections on the Source Selector Control switches the selected input on the sele
5. 510 gt This message is a set level message that tells the HAL to set external level control number 4 to a new value of 51 0 The protocol provides similar messages for getting and setting values for each of the four control types In addition to responding to messages it receives the Halogen HAL Control Server also sends messages to con nected control systems whenever one of the external controls configured in HAL changes This helps all of the con nected external control systems remain up to date as values or links change Using a Telnet Client to Test and Monitor the System Because the message protocol is ASCII text you can use a standard telnet client to connect to a Halogen or HAL Control Server and send receive messages This can be a great way to initially test your control system and to trou bleshoot any problems that occur while developing and deploying your system Appendix B Using PuTTY to Test External Control Systems on page 59 provides complete information for you to use a simple public domain Windows telnet client PuTTY with the Halogen HAL Control Server CHAPTER 3 Example HAL1x Configuration The external control system example uses a HAL1x configuration that includes a set of external controls linked to processing block and preset controls that demonstrate some common uses of the end user external controls There is at least one control of each type Command Level Selector and Toggle We ve also constructed thi
6. Add a new Toggle control by clicking on the button 6 Change the name of the new control to Wall Toggle Control and set its number to 5 7 Link the new Toggle external control to the wall toggle control in the Room Layout amp Control area Do this by dragging the link icon Figg in the External Control Systems dialog to the right of the control name and dropping it on the link icon Eed for the wall toggle control between the two rooms CHAPTER 3 Example HAL1x Configuration 8 Change the Label for the Wall Toggle Control to Wall Toggle The dialogs appear below as follows a Cree and e KI q Tiere ee ee eremm Select Togghe Command Label Enable Number Tels Wall Toggle Central W I Wall Toggle Ga F 5 CE Car DE Layout amp Control Room Processors Ze Silke Rinna Walla 1 peor Eee Foam Coambnaberns Se AIR A E I 2 At this point your external control system has access to three controls a selector to get and set the lounge input program source a level to control the lounge volume and a toggle to open and close the room combine wall Now well add some controls and link them to presets of various kinds to show how you can provide access to pre sets to your external control system First well add a toggle control to mute all of the outputs in our configuration 1 On the Processing Workspace Toolbar click on the Presets button to open the All Presets property dialog In the All P
7. Command Presets geeiert ia sabi 35 BEE 37 A A E chee 39 11 ZANE CRESTRON CONTROL SYSTEMS GUIDE SEENEN ee oe ee eee eed ee eee 40 Sore oelet EE 44 Preset Selector EE 46 a WEE 47 APPENDIX A HAL External Control Message Protocol o oooccccccccccccccccccccnccnccnoo 49 Details of external control messages 49 A A uate Sees 90 ESA y AA A O A A ae oe Resa denen 90 ea AA II mee uu seeieees 92 A o A O A A E 94 eeler lee 57 Communications Monitoring 2 22 22 eee e eee e cece cece rn 58 APPENDIX B Using PuTTY to Test External Control Systems _ 22 2 022 22 2 99 APPENDIX C Crestron Source Code occ 65 Trademarks geheiert Eege AE AE Ee E 67 111 CHAPTER 1 Overview About This Document This guide explains how to use a HAL DSP Processor with Crestron control systems It is divided into three major sections e Introduction to Using External Control Systems with HAL on page 4 Chapter 2 e Example HALIx Configuration on page 6 Chapter 3 e Integrating Crestron Control Systems with HAL on page 16 Chapter 4 Chapter 2 explains the general approach for configuring a HAL for use with any external control system and how to connect and communicate with the HAL Control Server The second section Chapter 3 walks you through the construction of an example Halogen configuration that includes one or two common uses for each type of external control Chapter 4 shows you how to set up an
8. External Control Systems dialog change to the Toggle tab if it 1s not already selected Make sure the Mute All Toggle Control toggle Value is un checked Open the three HAL1x output blocks and set the level for each to 20 0 dB and un check the mute toggle control 7 Add the three HAL1x output blocks to the new Default Level Preset by dragging the blue preset icon next to each HAL1x output block and dropping them on the blue rectangle for the Default Level Preset in the All Presets dialog o ot WN yH 8 In the External Control Systems dialog drag the blue preset icon for the Mute All Toggle Control and drop it on the blue rectangle for the Default Level Preset in the All Presets dialog This ensures that the Mute All toggle is reset unmuted when the Default Level Preset is asserted 9 In the External Control Systems dialog click on the Command tab 10 Add anew Command external control by clicking on the o utton 11 Rename this new control to Default Command Control and set its number to 3 12 Link the Default command control to the Default Level Preset s Assert button Do this by dragging the link icon in the External Control Systems dialog to the nght of the control name and dropping it on the link icon for the Default Level Preset s Assert button 12 CRESTRON CONTROL SYSTEMS GUIDE 13 Change the Default Command Control s Label to Default Level The dialogs appear below as follows Create and adit controh for gue in
9. Tool Help Online Support O8 BS WS Gn BA EE 22 m SES BF x Device Library System Views Sy Crestron Devices DvcLib 772 fi Control Systems CH Cresnet Control Modules Ey DigitalMedia CH Discontinued CH Ethernet Control Modules Gg Ethernet Audio Modules Sy Ethernet Audio Wideo Modules GC Ethernet based Cresnet Network Expansion CM Ethernet based Crestron Software Applications ZS Gees E Interface Si e Datalogi interface D Outlook 1 amp 2 Interface Y e Outiook 3 Interface cl PowerPoint Interface Y RoomView Express Roomwiew 6 0 Mi RoomView SE RoomView 7 0 Y Roomview 5E RoomView 7 2 D var Am Y Windows SideShow W I Windows SideShow Context y Ethernet LO Control GC Ethernet Intersystern Device Communication Ey Ethernet Join Number Remap Expansion Modul 4 Ethernet Remote Processing Modules Ethernet Video Modules o CH infiNeET Control Modules IIT 03 TCAP Cieni e control P Open the Rane HAL smw program file in SIMPL Windows Switch to the Configuration Manager Below the large controller device block in the upper System Views pane you will see a row of Ethernet Units The row con tains the following device icons TCP IP Client e control PC Interface and XPanel These devices originated from different folders in the Device Library tree Here are their locations so you can drag and drop them into sys tem configurations that you build yourself e Ethernet Intersystems Device Communicat
10. a look at them B 5 11 Rane HAL Level Processor Rane HAL Level Processor CONTROL_NUM LEVEL fo LOUNGE Level fb Lounge Level Slider LEVEL TO DSPSITO DSP FROM DSP2 FROM_OSPS Reference Namal Open the Rane HAL smw program file in SIMPL Windows Double click the Rane HAL Level Processor symbol under Logic in the Program View to bring up its details There is one HAL level control in this program uniquely identified by HAL control number 6 This control number appears in the Level tab of Halogen s External Control Systems dialog as Lounge Level Control It is also fed to the CONTROL NUM input of the Rane HAL Level Processor by an Analog Initialize symbol The Rane HAL Level Processor has two more inputs and two more outputs The FROM_ DSP input is driven by the RX output on the HAL s TCP IP Client The TO_DSP output drives the TX input on the HAL s TCP IP Client The LEVEL input is driven by the analog output from a slider on the XPanel The LEVEL fb signal drives the analog feedback input for that same slider Dragging the slider on the touch panel causes the Rane HAL Level Processor to convert changes in the LEVEL analog input to appropriate HAL Level values and send set level 37 ANE CRESTRON CONTROL SYSTEMS GUIDE messages to Halogen HAL These set level messages contain a level control type HAL control number and level value Valid set level messages for the HAL level control in this ex
11. can use the tabs on the Help Viewer s left pane to search the index click the Index tab or perform a full text search click the Search tab You can also use the Quick search box in the Help System toolbar to search for text within the currently dis played topic Lo HAL System Design Guide This guide is offered as a PDF file and contains a product overview details about the HAL System s key fea tures and best practices for designing a HAL audio system Note that the information in this guide is also available in the Halogen Help System You can find this guide on the Rane website http rane com hal as ZANE CRESTRON CONTROL SYSTEMS GUIDE well as on the product DVD HAL System Installation Guide This guide is offered as a PDF file and includes step by step instructions on installing the HAL hardware loading a configuration and testing the system This information is also included in the Halogen Help Sys tem You can find this guide on the Rane website http rane com hal as well as on the product DVD AMX Control Systems Guide This guide includes an introduction to using external control systems with HAL It also discusses an exam ple HALI configuration and how to set up an AMX controller and touch panel to communicate with a Hal ogen HAL Control Server In addition an appendix is included with reference information on the HAL external control message protocol and how to use a telnet client to monitor and troubleshoot the
12. control values by sending message strings to Halogen HAL These get selector messages are comprised of a selector control type and HAL control number The valid get selector mes sages for the two HAL selector controls in this program are lt S amp 1 gt and lt S amp 2 gt Halogen HAL responds to these get selector messages with corresponding set selector messages Lal NOTE Refer to Appendix A HAL External Control Message Protocol on page 49 for more information on selector messages The lt S amp 1 gt and lt S amp 2 gt get selector messages appears in the string parameter of the Serial Send symbol that is triggered whenever the TCP IP Client connects to Halogen HAL Requesting the selector values on connect ensures that the radio buttons on the XPanel are in sync with the live selector values on Halogen HAL 43 ANE CRESTRON CONTROL SYSTEMS GUIDE Append get selector messages to the set selector messages that the Serial I O sends out because Halogen HAL does not echo a set selector message back to the client that sent it For instance clicking on the Reggae radio but ton on the XPanel sends lt S amp 1 amp 2 gt followed by lt S amp 1 gt to Halogen HAL Upon receipt of the resulting lt S amp 1 amp 2 gt from Halogen HAL the Serial I O s outgoing REGGAE sel signal goes high The program relies on the response triggered by the get selector message to drive the feedback for a selector
13. controller modifies HAL toggle control values by sending message strings to Halogen HAL These set toggle messages are strings comprised of a toggle control type HAL control number and value The valid set toggle mes sages for the two HAL toggle controls in this program are lt T amp 4 amp 0 gt lt T amp 4 amp 1 gt lt T amp 5 amp 0 gt and lt T amp 5 amp 1 gt The controller also requests HAL toggle control values by sending message strings to the Halogen HAL These get toggle messages are comprised of a toggle control type and HAL control number The valid get toggle mes sages for the two HAL toggle controls in this program are lt T amp 4 gt and lt T amp 5 gt Halogen HAL responds to these get toggle messages with corresponding set toggle messages NOTE Refer to Appendix A HAL External Control Message Protocol on page 49 for more information on toggle messages The get toggle messages for the two HAL toggle controls appear in the string parameter of the Serial Send sym bol that is triggered whenever the TCP IP Client connects to Halogen HAL Requesting the toggle values on con nect ensures that the toggle buttons on the XPanel are in sync with the live toggle values on Halogen HAL Zi JANE CRESTRON CONTROL SYSTEMS GUIDE Wall_Toggle_ Button Double click one of the two Toggle symbols under Logic in the Program View to bring up its details Each tog gle button press signal from the
14. disconnected since both symbols only deal with strings traveling to and from Halogen HAL EF 5 12 Serial Buffer E Serial Buffer IP_CONNECTED IO Dep J TO_DSP TO_DSP2 i TO Dep TO_DSP3 TO_DSP l FROM_DSP g out4s FROM_DSP1 FROM Dep outss FROM_DSP2 The Serial Buffer symbol protects the program from problems that can occur when serial signals coming from Hal ogen HAL are jammed driven by multiple outputs Multiple symbols send strings to Halogen HAL so the Serial Buffer keeps them from stepping on each other Each symbol that wants to write to the TO_DSP signal gets its own input on the Serial Buffer 7TO_DSPI TO DSP2 TO_DSP3 etc The Serial Buffer routes these inputs to the same TO DSP output If multiple inputs are issued simultaneously the output is generated in successive order The end result is the same as giving each output a unique name and routing them to a Serial Concatenation symbol The strings coming from Halogen HAL are forwarded to different symbols for processing The Serial Buffer dupli cates the signal coming from Halogen HAL across multiple outputs The FROM DSP signal is forked into separate FROM DSPI and FROM DSP2 signals going out to the Serial I O and Rane HAL Level Processor symbols 24 CHAPTER 4 Integrating Crestron Control Systems with HAL slot 05 P 10 05 e control PC Interface e cortral Touchpanel La E fea e control Touchpanel MUTE Toggle ON fh foi pre
15. external control yee Lieve Select Toggle Command Harme Label Value Default Command Control I E Default Level Default Level 20 Gain F 0H amp Mir S ad Create and turen presets i Maud Lt Arale Output Port 3 Line Toggle Selector Command Acaton Preset Name Boost i Reene Assert d Default Level Preset 200 Gar Preset E Duplicate Move 7 Of Men FF ONO Min Actre Presets Insert invert Priority Active Preset ScratchPad 1 Det sult Level Prezas J Ad Ce AH Preset Mute 2 Finally we ll create a selector preset to provide three options for the PEQ settings in the lounge 1 In the All Presets dialog click on the Selector tab 2 Create a new Selector preset by clicking on the Selector button 3 Rename this selector preset to PEO Preset Selector 4 Add three presets to this selector by clicking the Preset button three times 5 Change the names of these presets to Soften Vocals Smooth and Boost Bass 6 Activate the Soften Vocals preset by clicking on the radio button to the left of its name in the All Presets dialog Then uncheck the Include No Selector checkbox at the bottom of the PEQ Selector Preset 7 Open the property dialog for the PEQ block and set the Gain to 5 0 and the Frequency to 3276 8 Add the PEQ block to the Soften Vocals preset that is the first preset in the selector preset To do this drag the blue Preset icon next to the PEQ block in the processing map and drop
16. ing a HAL configuration that contains external controls either to monitor the operation of your external control system or to serve as a simple form of external control system before the production system is ready or available Any telnet client will work but this section shows how to do this with PuTTY an open source telnet client appli cation that is free easy to install and use and runs on all versions of Windows How to obtain and install PuTTY The top level web page for PuTTY is http www putty org That page contains a link to a page that has links for downloading the PuTTY application All you need is the latest release version of putty exe for Windows on Intel x86 Download this file and put it in an accessible folder on your PC Since the complete installation is a single file putting it on the desktop works great Starting PuTTY and configuring it for communications with the Halogen control server Start PuTTY by double clicking on the putty exe file This brings up the PuTTY Configuration window Tee PuTTY Configuration E Basic options for your Pu T TY session Specify the destination you want to connect to Host Name or IP address Port 23 Connection type Raw Telnet Rlogin 55H Serial Appearance ae Load save or delete a stored session Behaviour Saved Sessions ke Colours Connection Data Clase window on exit Always Never 9 Only on clean ext To connect to the Halogen
17. is going to be executed The example program comes with the Default Address set to 10 0 0 6 Change this address to match the IP address of your PC For now this should be the same PC running Halogen You can change it again later if you decide you want to try running the XPanel from a different PC XPanel This section shows you how to set up the XPanel executable s communication settings so that the examples work Have the IP address of your controller and the IP ID of the e control handy before proceeding Project Properties Design Information Web Compile Page Resize Protection Commuricabon Port Pott 41734 acting to the control system directly fill out the 41794 Open the Rane HAL TP vtp project file in Vision Tools Pro e Right click on the Rane HAL TP project in the Project View and select Properties Select the Web tab in the Project Properties dialog Enter your controller s IP address for both Control System Info and e control Gateway Info Make sure that the IP ID of the e control not the IP ID of the XPanel is selected Recompile the XPanel to apply the new settings to the executable 22 CHAPTER 4 Integrating Crestron Control Systems with HAL Ethernet Communication Symbols A number of symbols in the example program are wired for TCP IP communications with Halogen HAL and e con trol Trace through the TCP IP Serial Signal Flow diagram to get an overview of how these symbols work together
18. the Default Level button on the XPanel The slider jumps to 50 Also notice this command button doesn t stick like the previous toggle buttons Now adjust the Lounge slider down to 10 and assert the Default Level Preset from Halogen The slider on the XPanel jumps back to the center again NOTE Refer to Appendix B Using PuTTY to Test External Control Systems on page 59 for help with debugging if the system does not behave as described here 36 CHAPTER 4 Integrating Crestron Control Systems with HAL Levels mune Level Sater Rane HAL Level Processor Lounge Lei Ain CONTROL NUM TO_DSP3 FROM Dh FROM_DSP FROM_OSP1 FROM DP FROM_OSP2 GZ This section explains how to integrate HAL level controls with sliders on an XPanel by looking at a volume slider on a touch panel We start by breaking down the logic symbols and signal flow for the HAL level control Then we examine how to bind the HAL level control to a slider in the touch panel user interface The level controls on a HAL that are accessible to an external controller have a value range of 0 to 1000 Compare that with the 0 to 65535 range of Crestron analog signals This discrepancy requires a Crestron controller to con vert the level values it gets from and sends to a HAL HAL levels map naturally to sliders on Crestron touch pan els The example program contains symbols to deal with slider movements on a touch panel and level messages from a HAL Let s take
19. this to HAL to request the current value of a selection name for a particular selection item of a Select external con trol It is not meaningful to send this message to HAL because an external control system can not change a selection name HAL sends this Ls Send this to HAL to request the current label value ofa Selector external control in response to a get selection name mes sage whenever the link activation changes for the Select exter nal control whenever one of the selection names change lt SN amp 12 amp 2 gt get the current selection name for selection item 2 of Select con trol number 12 Selection item 2 is the third item in the set of selec tions lt SN amp 12 amp 2 amp Jaz z gt set the cur rent selection name for selec tion item 2 of Select control number 12 to Jazz Selection item 2 is the third item in the set of selec tions lt SA amp 1 gt request the cur rent label value of Selector exter nal control number 1 APPENDIX A HAL External Control Message Protocol Send this to HAL to set the label for a Selector external control to a new value Set label message where lt SA amp 1 amp HAL sends this Program gt set Ee ay er ee n is the control number l the lab l value S 1 in response to a get foe Selector con string is the label for the control label message trol number 1 to 2 whenever a label for Program a Select
20. to default levels control number 3 This sets the three outputs to 20 0dB and un mutes them In addition it sets the Mute All toggle control to unchecked so the state is consistent with the outputs being un muted CHAPTER 4 Integrating Crestron Control Systems with HAL Overview This guide describes how to setup a Crestron controller and virtual touch panel to communicate with a Hal ogen HAL Control Server It is designed to be used in conjunction with the files found in the Crestron Support Package The contents of this support package include e CrestronControlSystems Guide pdf The guide you are reading now e ControlSystemSample hal Halogen configuration file intended for loading in Halogen or your HAL1x e Rane HAL smw SIMPL Windows program project file e Rane HAL TP vtp VisionTools Pro e touch panel project file e Rane HAL Level Processor usp SIMPL user module source file e Rane HAL Level Processor ush Compiled user module The Crestron Support Package 1s installed with the Halogen software and can be accessed from the Windows Start Menu under Rane Corporation gt Halogen gt Guides gt Crestron If you want to access the files directly they are avallable on the product DVD or from the Halogen install directory e Windows 7 or Vista C Program Files x86 Rane Corporation Halogen Guides Support Packages Crestron directory e Windows XP C Program Files Rane Corporation Halogen Guides Support Packages Crestro
21. 0 0 0 8 10 0 0 9 Ethernet Switch Later on you can choose to run the XPanel on a different PC to simulate a more realistic installation environment For now run Halogen and the XPanel on the same PC as shown in the Minimal Example Network diagram Run the example program on the controller so that 1t can talk to Halogen Control Server and the XPanel Open the Rane HAL smw program file in SIMPL Windows Switch to the Configuration Manager If your controller is not an MC2E right click on the MC2E node in the lower System Views pane and select Replace MC2E from the context menu to bring up the Select New Device dialog Select the model of your controller from that dialog and click the OK button Change the server address of the TCP IP client and the IP address of the XPanel so that they both match your PC s IP address Compile the program and transfer the resulting Rane HAL spz file to your con troller Compile and run the XPanel on the PC so that 1t can talk to the controller User interface widgets on the XPanel are assigned to specific outputs in the program so the two depend on each other Open the Rane HAL TP vtp project file in Vision Tools Pro e and hit F12 to compile it This will generate a Rane HAL TP exe folder in the same directory as the project Double click the LaunchXPanel exe file located in this new directory to run the XPa nel 18 CHAPTER 4 Integrating Crestron Control Systems with HAL You know all of the componen
22. 26 thea gt 80 Rea Active Face Coo fi dncup k ARAARA GLEBE 0400080 10 AA DP a bs ky ae g oS FE E dh gt Eu ls k O Abra s EI e OH e E e 10 e L n 0 0 0 5 gt Bs E f bei Vifre My Rane_HAL_TP BE Sh Synchronize States Desonplisn Page Flap Type Sappress Key Click Object Hare formulation Mode Template Data Mute All O Wall Open D Togdles Type select a digital press join from the bet box by dhclong of click A bo automatically assign the D st Svaabie ga ca chopze a reserved jon number Curpor 225 571 Page Fip Nore Jon 2 Open the Rane HAL TP vtp project file in Vision Tools Pro e Next open the Sound page window to view the example touch panel design Select the Wall Open button in the Sound page window Notice that the Digital Press Join number for this button is set to 2 to match the fb2 input and press2 output on the XPanel symbol in the program The touch panel button will appear raised when it is in its inactive state and depressed when it is in its active state Double click the Room Combine 1 block in the Halogen Processing map to open its properties dialog Select the Layout and Control tab in the Room Combine 1 dialog Launch the XPanel and verify that the Connected status indicator shows that you are connected Refer to the Troubleshooting on page 47 section if it the status indicator says Disconnected Watch the wall between rooms A and
23. AAA GG Ges em D AA ENEI E GE Ga K Active Face Color el Pa pem BE fF U gt E a ViPre e BW Sound C AUsers Frank Documents Rane HAL Crestron Sempla 2 fa Property Maret Property Vale Mg Rane HAL TP E Button D EXA DK Synchronize States Yer Descnetion Casal Deg Loun E A Je Page Flip None oO 8 0 Page Flap Type Page e E b afo Classical E i h We Dlepect Ham sm Moda Meengotap eee Epee ARO Lues 280 280 Page Fi None Jord 6 Launch the XPanel and verify that the Connected status indicator shows you are connected Refer to the Trou bleshooting on page 47 section if it the status indicator says Disconnected Double click the Selector 1 block in the Halogen Processing map to bring up its properties dialog Click on the Jazz radio button in the Selector 1 Block dialog Then click on the Classical radio button on the XPanel The selected input in Halogen switches from Jazz to Classical Now click on the Reggae radio button in Halogen The Classical radio button 1s selected and the Reggae radio button 1s deselected on the XPanel NOTE Refer to Appendix B Using PuTTY to Test External Control Systems on page 59 for help with debugging if the system does not behave as described here 45 JANE CRESTRON CONTROL SYSTEMS GUIDE Preset Selector This example demonstrates how to get radio buttons on a touch panel to switch between presets on a HAL The example Halogen configuratio
24. AL control numbers appear in the Toggle tab of Hal ogen s External Control Systems dialog as Mute Toggle Control and Wall Toggle Control 26 CHAPTER 4 Integrating Crestron Control Systems with HAL DN Slot 05 1P 1D 04 XPanel XPanel E o Ma XPanel Digitals IMUTE Toggle ON fb fi pressi III Mc WALL Toggle ON _fb fo press MER Ce Tite 13 press3 Default Command Button PA pressa Default Command Button 5 press5 n CLASSICAL sel fb fe presso Classical Radio Button JAZ sel fb LH press Jazz Radio Button n REGGAE sel fb JS press Reggae Radio Button 5 WE Tba presso O SOFTEN sel fb 10 press10 Soften Radio Button SMOOTH sel fb 11011 press11 mooth_ Radio Button E BOOST sel fb 12 press72 Boost Radio Button 013 press13 IP CONNECTED fb14 press 14 1015 press15 Double click the XPanel symbol under Slot 05 of the MC2E in the Program View The Mute Toggle Control maps to the digital fb1 input and press1 output on the XPanel The Wall Toggle Control maps to the digital fb2 input and press2 output on the XPanel The outgoing press signals for the two toggle buttons on the XPanel are named Mute Toggle Button and Wall Toggle Button A press signal from an XPanel goes high when that touch panel button is pressed and falls back down to low as soon as it is released Double click the Serial VO and Serial Send symbols under Logic in the Program View to bring up their details The
25. B appear and disappear as you click the Wall Open button on the XPanel open and closed Now toggle the wall open and closed from the Room Combine 1 dialog and watch that same button turn on and off on the XPanel NOTE Refer to Appendix B Using PuTTY to Test External Control Systems on page 59 for help with debugging if the system does not behave as described here 33 ANE CRESTRON CONTROL SYSTEMS GUIDE Commands This section explains how to integrate a HAL command control with buttons on an XPanel by examining a single application a touch panel button that asserts a HAL preset We start by breaking down the logic symbols and sig nal flow for the HAL command control Then we examine how to bind the HAL command control to a button in the touch panel user interface Command controls are stateless in a HAL system Unlike toggles they have no on or off values HAL Command controls are merely triggers for predefined actions like command presets Think of them as Fire and forget Because they are stateless the feedback for a command button on a touch panel must be momentary The example program has symbols to deal with command button presses from a touch panel Let s take a look at them Open the Rane HAL smw program file in SIMPL Windows Double click the XPanel symbol under the Ethernet slot of the controller and the Serial I O symbol under Logic in the Program View to bring up their details Mo Ma Bs XPanel Digi
26. Button and the signal to its fb2 input is named Wall Toggle ON fb The ON and Off substrings appear in the names of some of the digital signals used for toggles A toggle button press could be turning a toggle on or off depending on its previous state A press signal is transient so other sig nals are needed to capture and maintain the toggle s state When a signal with an ON suffix goes high that always indicates a toggle ON event When a signal with an Off suffix goes high that always indicates a toggle Off event Several touch panel button press signals have a Radio Button suffix at the end of their name The suffix is intended for radio buttons that operate together as members of a group Take the Source selector group of radio but tons on the XPanel for example If the Classical radio button is selected then the Jazz and Reggae radio buttons must be deselected Because they are so closely related the signals for radio buttons belonging to the same group are arranged close to one another throughout the program A sel substring is used in digital signal names to indicate that signal is part of a selector It takes the place of the Radio Button suffix in selector signals that aren t driven by the touch panel Take the Source selector as an exam ple The Serial I O has outgoing CLASSICAL sel JAZZ sel and REGGAE sel signals for the three different source selector positions that can come from Halogen HAL The sei substring also appears in the na
27. HAL Crestron Control Systems Guide T CRESTRON SS ww Halogen Software Crestron Control Systems Guide Version 4 Crestron is a registered trademark of Crestron Electronics Inc Table of Contents CHAPTER 1 Overview o 1 EE OC UIC IN eege ed ee 1 Using the HAL System Documentation o oooccccccccccccccccccocccnc nono 1 GETING SIAC EE 3 CHAPTER 2 Introduction to Using External Control Systems with HAL 22 4 Configuring External Controls in Halogen 0 2 22 22 e eee cee cee ce eee cece cece eee ec eee eeeeeeeeee 4 Connecting to a Halogen HAL Control Gene 4 Communicating with a Halogen HAL Control Server 0 0 002 22 cee cece cee cece cece eee eceeeeeees 5 Using a Telnet Client to Test and Monitor the System 0 00222 c eee eee cece eee eens 5 CHAPTER 3 Example HAL1x Configuration 0 00 00 2occ cece cece cece cece ee eeee 6 Creating the Example Configuration 0 00 002 2 cece e ccc cece ccoo 6 Configuration Summa EE 15 CHAPTER 4 Integrating Crestron Control Systems with HAL 000 16 TEE 16 A AA A 17 GETING SACO EE 17 Configuring IP Addresses ooo cee eee cece eee cee eee e eee e cece cece eceeeeeeeeees 19 HA e A Se ee 20 POMC EE eebe 22 Ethernet Communication Symbols 23 FONNING AA Sk a hae eat A tine tea cu 25 OG NS Se oa ors ees E E E E 26 A A A II A SN 29 Wall Kee il 32 COMMands casta o de ee 34
28. L does not echo a set toggle message back to the client that sent it This is needed because the visible state of a touch panel toggle button is determined by its feedback signal and feedback is only generated from incoming set toggle messages Signals coming out of the Serial I O go high when matching message strings are received from Halogen HAL Take the Mute Toggle Off signal for example This signal goes high when a set toggle message string of lt T amp 4 amp 0 gt 1s received The signal won t go low again until another character is received and a match with the nght most characters of the input string no longer exists The same technique applies to the Mute Toggle On signal when a set toggle message string of lt T amp 4 amp 1 gt 1s received S S 6 Set Reset Latch ole MMUTE_Toggle_ON MUTE Toggle Off Double click one of the two Set Reset Latch symbols under Logic in the Program View to bring up its details Notice that Toggle ON and Toggle Off signals from the Serial I O drive the set and reset inputs The Set Reset Latch merges the two inputs into a single Toggle ON fb signal This outgoing feedback signal is latched so that when a toggle value change is received the toggle button stays in its new on or off state The feedback signals from the Set Reset latches drive the fb1 and fb2 feedback inputs for the two toggle buttons on the XPanel These feedback signals are generated by the set toggle messag
29. NDIX B Using PuTTY to Test External Control Systems For example the HATT host properties dialog will look something like this wr KA d F Status and network seringi for the HAL host device Alan s HALL locate 2 17 2017 11 03 27 AM 7 Status Configuration Mismatch Some Motes Host Name RANEHAL Link Local 169 254 141 159 DHCP Assigned None DHCP Enabled Enable Disable Default Gateway None static Static IP Subnet Mask 100M3 Ek a III MAC Address 1 l faceP02 03 senal Number 1327 Insert Date Time Here We ve added a static IP of 10 0 0 113 We ll use this in the PuTTY Configuration window 6l ANE CRESTRON CONTROL SYSTEMS GUIDE d Session hu Logging Terminal Features 7 Window Behaviour Translation a Selection Colours J Connection 8 Data Telnet a Rlogin Basic options for your PuTTY session Specify the destination you want to connect to Host Name or IP address Port 10 0 0 113 4996 Connection type Raw o Telnet Rlogin 55H Serial Load save or delete a stored session Saved Sessions Default Settings Close window on exit Always Never Only on clean Communicating with the Halogen HAL control server Connecting PuTTY to either Halogen or HAL establishes communication between the telnet client and the control server Now you can send and receive messages using the PuTTY window that appears For example suppose you have a Level control configur
30. TY 3 See how the HAL control server responds when configured presets activate or deactivate that affect exter nal control values or link activations Connect PuTTY to your HAL or Halogen external control server and activate or deactivate presets that contain blocks or links related to external controls Observe what the control server sends to PuTTY 4 Use PuTTY to monitor the operation of your external control system 63 64 ANE CRESTRON CONTROL SYSTEMS GUIDE You can connect any number of external control clients to a Halogen or HAL Control Server This means that when you are developing and testing your control system with a commercial product such as an AMX system you can also connect to the control server using PuTTY NOTE This lets you monitor most of the interaction between your external control system and your Halogen HAL Control Server This works because when external controls change the Hal ogen HAL Control Server sends these changes to all connected external control clients So when your external controller changes a control on the HAL the HAL control server sends the change to your PuTTY client To use PuTTY in this way first connect PuTTY to the Halogen HAL Control Server that you want to monitor Next connect your control system to the same Halogen HAL Control Server As your external control system interacts with the HAL system external control messages will appear in the PuTTY win dow giving you information a
31. XPanel drives a clock input on a Toggle symbol The Toggle symbol translates the button press into separate toggle ON sel and toggle Off sel signals When the toggle ON sel signal is high the toggle Off sel signal is low and vice versa These signals are latched by the Toggle symbol so that when you let go of a toggle button on a touch panel it stays in 1ts new on or off state EX 5 3 Serial YO FROM_OSP1 ind Ip CONNECTED enable Classical_Radio Button lt S8180 gt lt S81 gt Jazz Radio Button Jestas O o Reggae Radio Button Soften Radio Button Smooth Radio Button Boost Radio Button Default Command Button MUTE_Toggle_Off_se lt Ta4 amp 0 gt lt T amp d MUTE_Toggle_ON_sel TRA 1 gt lt TEA gt tid SCH Geen O sel 0 CTT ETC ero ALL Toggle ON sel lt Tasai gt lt Tas gt srt Wl LEE W WALL Toggle OF WALL Toggle OWN delimiter AcO Dix OA The two Toggle symbols outgoing toggle ON sel and toggle Off sel signals are what trigger the toggle set messages sent by the Serial I O Take the Mute Toggle Off sel signal for instance When that signal goes high a set toggle message to turn HAL toggle control 4 off is sent The set toggle message is immediately followed by 28 CHAPTER 4 Integrating Crestron Control Systems with HAL a get toggle message for the same HAL toggle control Remember to include a get toggle message with any set toggle message because Halogen HA
32. You will probably use these same symbols to connect to Halogen HALs in your own programs so now let s look at them up close outs E IL Kb FRA Lob IP Lengt TL FROM DEP GEZ iO Op Open the Rane HAL smw program file in SIMPL Windows and switch to the Program Manager Click on the Program View pane so that it is in focus and select Expand All from the View menu Double click the TCP IP Client and e control Touchpanel symbols under the Ethernet slot of the controller to open their details dialogs Then double click on the Analog Equate and Serial Buffer symbols under Logic to open the details for those up TO_DSP 23 ANE CRESTRON CONTROL SYSTEMS GUIDE The Port parameter for a TCP IP Client connecting to a HAL should always be set to 4996 The same goes for a client connecting to a PC that is impersonating a HAL Data gets sent to Halogen HAL via the symbol s serial TX input Data from Halogen HAL comes out the symbol s serial RX output The Connect digital input is held high so that the client keeps trying to reconnect if the connection is lost MN 5 1 Analog Equate Tala le ID CONNECTED When a connection attempt succeeds the outgoing analog JP_STAT signal becomes a 2 This triggers the Analog Equate symbol s outgoing digital ID CONNECTED signal to go high The Serial Buffer and Serial IO symbols are only enabled when JP CONNECTED is high They are disabled when the client is
33. ample program are lt L amp 6 amp 0 gt lt L amp 6 amp 1 gt lt L amp 6 amp 2 gt all the way to lt L amp 6 amp 1000 gt Halogen HAL sends these same set level messages to the controller whenever another client changes a HAL level control value These set level messages from Halogen HAL are processed by the Rane HAL Level processor which converts them from the HAL level range to Crestron analog signal range resulting in feedback to the touch panel slider The controller also requests HAL level control values by sending message strings to Halogen HAL These get level messages are comprised of a level control type and HAL control number The get level message for the HAL level control in this program is lt L amp 6 gt Halogen HAL responds to this get level message with a cor responding set level message NOTE Refer to Appendix A HAL External Control Message Protocol on page 49 for more information on level messages Slot 05 1P 10 04 XPanel XPanel XPanel Analogs LOUNGE Level mp an_fb1 an adi Lounge Level Slider Jan_1b2 an_act gt an_fb3 an_act3 lan fu an SCH Jan T an_actS an_fb6 an_act an fi an_act Jj an_1b8 an_act i an_1b9 an ach an_fbi0 an_actio an_fo11 an_acti an_b12 an_acti an_fb13 an_acti3 anbi an_acti4 an_1615 an_acti5 8 Double click the XPanel symbol under Slot 05 of the MC2E in the Program View to bring up its details Click on the Anal
34. ane Corporation Halogen Guides Support Packages Stardraw Con trol directory You can also download the most up to date version of this support package from the Rane website http rane com hal Getting Started Read this document in sequence if you are completely new to learning about and using external control systems with HAL and the Halogen software Chapters 2 and 3 appear in other control systems guides so you can skip these if you ve already read them The Crestron example in chapter 4 refers to the example HAL1 configuration often so you may want to familiarize yourself by reading chapter 3 before starting on chapter 4 CHAPTER 2 Introduction to Using External Control Systems with HAL This section is a brief overview of the support that the HAL system provides for external controls and how your system can connect to and use these controls For more information on this topic please see the Halogen Online Help Configuring External Controls in Halogen Halogen provides the ability to configure controls for use with external control systems These controls can be of any of the four types that Halogen supports Level Toggle Selector and Command Once you create an external control in Halogen using the Control Systems dialog you can then link it to any other linkable control of the same type in your Halogen configuration This lets your external control system set and monitor any linkable parameter in your HAL configuration Since
35. bout the operation of your external control system APPENDIX C Crestron Source Code SYMBOL NAME Rane HAL Level Processor DEFAULT VOLATILE analog input CONTROL NUM analog input LEVEL p fter input EROM DSPo 12335 analog output LEVEL fb String Output TO DSPs integer controlNum prevLevel nextLevel integer nextChar startIndex endIndex String Jane change FROM DSPS do nextchar gecc FROM DEE line line chr nextChar if nextChar 0x0D startIndex find lt L amp line if startIndex startIndex startIndex 3 endindex find amp line startIndex controlNum atoi mid line startIndex endIndex 1f controlNum CONTROL NUM startindex endIndex endindex find gt nextLevel atoi mid line startIndex endIndex line startIndex 1f nextLevel prevlevel prevLevel nextlevel LEVEL fb nextLevel 65535 1000 line until len FROM DSPS 0 change LEVEL 65 66 CANE CRESTRON CONTROL SYSTEMS GUIDE LEVEL fb LEVEL nextlevel LEVEL 100076552357 1f nextLevel prevLevel prevLevel nextlevel TO DSPS PELS toa CONTROL NUM Ten toa nextlevedl TST HAL Crestron Control Systems Guide AMX and the AMX logo are registered trademarks of AMX Stardraw Control is a trademark of Stardraw com Ltd Crestron is a registered trademark of Crestron Electroni
36. cs Inc Lexan is a registered trademark of General Electric Decora is a registered trademark of Leviton Windows is a registered trademark of Microsoft Corporation in the United States and other countries Apple Mac Macintosh iTunes Safari QuickTime GarageBand and OS X are registered trademarks of Apple Inc registered in the U S and other countries Halogen is a trademark of Rane Corporation ORane Corporation 10802 47th Ave W Mukilteo WA 98275 5000 USA TEL 425 355 6000 FAX 425 347 7757 WEB rane com
37. ctor block e Sat D UE Bi Li DN ays EN ns F Create and edit controk for use in extemal control syrtems Level Select Toggle Command Name Label Enable Number L azs Te d d Reggae Tone 44 CHAPTER 4 Integrating Crestron Control Systems with HAL Open the ControlSystemSample hal example configuration file in Halogen Then open the External Control Sys tems dialog and select the Selector tab The selected item in the Value column for the Source Selector Control is the input currently selected by that selector in the system The set of radio buttons also reflects the current selec tion Select a different item for the Source Selector Control to choose a different input Open the Rane HAL TP vtp project file in Vision Tools Pro e Next open the Sound page window to view the example touch panel design Select the circular Classical radio button in the Sound page window Notice that the Digital Press Join number for that button is set to 6 to match the fb6 input and press6 output on the XPanel sym bol in the program The Digital Press Join numbers for the other two source selector radio buttons are 7 and 8 A radio button will appear blue when it 1s in its active state and blacked out when it is in its inactive state Col Crestron Von Tool Pro e XPANEL Cr Ucers Frani Documents Rane HAL Crestron Sample Rane_HAL_TP tp IR Ro x File Edi Drew Leca Display Options Tools Window Help so amp b RH BR SS jwn SEH EI ch e b A
38. d program a Crestron control system to work with a HAL that is run ning the example configuration The appendices provide helpful reference information about the HAL external control message protocol and how to use a telnet client to monitor and troubleshoot the operation of a control system at the message protocol level Using the HAL System Documentation A variety of documentation is available to help you get started with and use your HAL System Halogen Help System A comprehensive help system 1s installed with the Halogen software It contains all the information you need to work with the system There are several ways to access the Help System e Click the Help icon on the application toolbar Clicking the icon itself opens the Help System Clicking the down arrow displays a list of options including such things as access to the Rane web site checking for updates to the Halogen software and sending an email to Rane e Click the Help icon that appears in the upper right corner of Halogen dialog boxes Clicking this icon opens the Help topic related to the specific dialog box From there you can access the entire Help System if needed e Right click on different elements in the user interface A Help option appears in the context menu Click this option to open the relevant Help topic Pressing F1 when an area of the user interface has focus also displays its relevant Help topic e To search for information within the Help System you
39. e PEQ Preset Selector so that its contents are visible Click the Smooth radio button in the All Pre sets dialog Then click on the Soften Vocals radio button on the XPanel The selected preset in Halogen switches from Smooth to Soften Vocals Now click on the Boost Bass radio button in Halogen The Boost Bass radio but ton is selected and the Soften Vocals radio button is deselected on the XPanel NOTE Refer to Appendix B Using PuTTY to Test External Control Systems on page 59 for help with debugging if the system does not behave as described here Troubleshooting Ifthe XPanel does not connect to the controller e Check to make sure the controller s IP address configured in the XPanel is set correctly e You can find and edit the IP address of your controller by using Crestron Toolbox to con nect to it via a serial RS 232 interface e Or you can edit XPanel s Project Properties in Vision Tools Pro e so that the Control Sys tem and e Control Gateway IP addresses are set to your controller s current IP address 47 CANE CRESTRON CONTROL SYSTEMS GUIDE 2 or 48 e The XPanel will also fail to connect to the control system if the IP ID it is attempting to use is wrong e The IP ID selected in the XPanel s Project Properties should be that of the e Control e See the Ethernet Units on page 20 section for how to find and modify these XPanel set tings If the controller cannot connect to the Halogen Control Server
40. e the Serial I O receives from Hal ogen HAL These set toggle messages are the same strings sent by the Serial I O when toggle buttons are pressed on the XPanel They may arrive unsolicited or in response to a get toggle message NOTE Refer to Appendix A HAL External Control Message Protocol on page 49 for more information on toggle messages Toggle Presets This example demonstrates how to get a toggle button on a touch panel to activate and deactivate a Halogen HAL preset The example Halogen configuration file contains a toggle preset for muting and unmuting all the outputs on a HAL This Mute AU Preset is linked to a Control Systems toggle control named Mute All Toggle Control Toggling this HAL control activates or deactivates the preset 29 CRESTRON CONTROL SYSTEMS GUIDE Ter ONTO Wstemis qe o E i ove Lems Create and edit controls for use m extemal control systems Level Select Toggle Command Name Label Value Enable Number Wall Toggle Wall Toggle ci Open the ControlSystemSample hal example configuration file in Halogen Then open the External Control Sys tems dialog and select the Toggle tab The Value checkbox for the Mute All Toggle Control reflects the current state of that HAL toggle control 30 CHAPTER 4 Integrating Crestron Control Systems with HAL ALA Crestron Vision Toots R Pro e KPANEL C ers trankviDecuments Rane HAL Crestron Sample Rane HAL_TP vtp File Ede Drew Layout Displey Qpti
41. ed in Halogen that is control number 1 and currently has a value of 60 5 To request the current value of this control type lt L amp 1 gt into the PuTTY window and then press Enter This will send the message to Halogen which will respond with lt L amp 1 amp 605 gt If all is right with your test system you ll see something like this gp PC 051711 RANE LOCAL PuTTY 62 APPENDIX B Using PuTTY to Test External Control Systems Your Halogen configuration will be something like this the Level external control is linked to the Level block s level control Externa Create aed eds controk for ute in external combrol ememr Level Select Toggle Command Name Label Value Enable Number Wan T e Level 1 in FA FE 1 af agi HH oi AE RA Gain F Of Min Mute 4 How to use PuTTY when testing external control systems Here are a few ideas for what you can do 1 Test your HAL external controls by sending and receiving external control messages To do this connect PuTTY to your HAL or Halogen external control server and type external control mes sages into the PuTTY window and observe what HAL sends in response 2 See how the HAL control server responds when you change external controls either from Halogen or from actual remotes in the HAL system Connect PuTTY to your HAL or Halogen external control server and change external controls from within the HAL system Observe what the control server sends to PuT
42. el Processor 39 ANE CRESTRON CONTROL SYSTEMS GUIDE WA Crestron Vision Toots R Proce DIPANEL Gilsen frenk Documents Rane HAL Crestron Sample Rane HAL TB ap Cir File Ed Drew Let Dpp Opbons looks Window Help Wei a B B amp 6 tea GHT ee ee ol kh ease GLEBE emm DD AA OB P d Ge fs k k O A ON De DI A 0 0 0 0 0 E WE HA WTPro e Geschl J ks Property Mars Property My Rane HAL TP DE IB ae Depeonpiion Cual Press Leer 0 ral A O i MUDO Suppreta Key L ck Ha Lena Betum Cd Signed Touch He Object Maeve Teeiate Data Poubon and Size O J o 0 H len re de E Pokai RBA Cursor 03 5 de Jon Launch the XPanel and verify that the Connected status indicator shows that you are connected Refer to the Troubleshooting on page 47 section if it the status indicator says Disconnected Drag the Lounge slider up and down on the XPanel to adjust the level continuously The percentage shown for the Lounge Level Control in Hal ogen fluctuates with your slider movements Double click the HAL Line Output 1 block in the Halogen Proc essing map to bring up its properties dialog Now drag the slider for the level in HAL Line Output 1 block dialog back and forth in Halogen The slider on the XPanel moves up and down in conjunction with the level NOTE Refer to Appendix B Using PuTTY to Test External Control Systems on page 59 for help with debugging if the syst
43. em does not behave as described here Selectors This section explains how to integrate HAL selector controls with buttons on an XPanel by examining a couple of touch panel applications input source selector radio buttons and preset selector radio buttons We start by break ing down the logic symbols and signal flow for the HAL selector controls Then we examine how to bind the HAL selector controls to radio buttons in the touch panel user interface 40 CHAPTER 4 Integrating Crestron Control Systems with HAL ARAL sei Sp JAZZ sel Ti are A Aiba Battes lag Baden Bam CLASSICAL ue Sege Badoo Buty Sollten Apdo Paie Arngcgb Ario Bung Bomi Akio Bagtom Wati sel E PACHA ez Tite SOFTEN sei fi At its simplest a HAL selector control is just a selection integer value The range of this selection value is con strained by the number of positions on the selector For instance a HAL three way selector can only have a value of 0 1 or 2 The example program contains symbols to deal with radio buttons on a touch panel and selector mes sages received from Halogen HAL Trace through the Selector Control Signal Flow diagram to get an overview of how these symbols work together before we look at them up close Open the Rane HAL smw program file in SIMPL Windows There are two HAL selector controls in this program uniquely identified by HAL control numbers and 2 These HAL contr
44. exhibit feedback when they arrive 34 CHAPTER 4 Integrating Crestron Control Systems with HAL The momentary nature of a HAL command control makes generating feedback for a button on a touch panel very simple Just route the touch panel button s press output signal to the feedback input signal That s all there is to it The button on the XPanel will only appear active when you hold it down Command Presets This example demonstrates how to get a button on a touch panel to trigger a command preset on a HAL The exam ple Halogen configuration contains a command preset that sets the levels of all the HAL line outputs to a default level of 40 0 dB A preset like this 1s handy when a user wants to revert undesired audio settings back to their original defaults The preset is linked to a Control Systems command control named Default Command Control Invoking the HAL command control asserts the preset Open the ControlSystemSample hal example configuration file in Halogen Then open the External Control Sys tems dialog and select the Command tab Clicking on the Default Level button in this dialog fires the HAL command control a u KK TE me L Tat D A dE i l i Create and edit controls for use in extemal control systems oe CALE Level select Toggle Command Name Label Value Enable Number Te Default Level Default Level o oo Open the Rane HAL TP vtp project file in Vision Tools Pro e Next open the Sound page windo
45. external control server do the following 1 Start Halogen and load your configuration that contains the external controls you d like to test 59 FANE CRESTRON CONTROL SYSTEMS GUIDE 2 In the PuTTY configuration window a Enter localhost in the Host Name text box b Change the Connection type to Telnet Change the port number to 4996 Click the Open button fee PuTTY Configuration LX p I Basic options for your PuTTY session Specify the destination you want to connect to Host Name or IF address Port localhost 4996 Connection type O Raw Telnet Rogn S5H Se al Load save or delete a stored session Saved Sessions Default Settings Close window on exit O Aways Never 9 Only on clean exit To connect to the HAL external control server do the following l 60 Start Halogen and Apply your configuration that contains the external controls you d like to test to the HAL Open the HAL property dialog by double clicking on the HAL title bar in the Halogen Hardware Work space eee Alan s HALIX Observe the HAL s configured IP addresses and pick one that you want to use with PuTTY The address you choose needs to be on the same network as your PC that is running PuTTY In the PuTTY configuration window a Enter HAL s IP address in the Host Name text box b Change the Connection type to Telnet c Change the port number to 4996 d Click the Open button APPE
46. f 11 Add the three HAL1x output blocks to the Mute All Preset To do this hover your mouse over the HAL Ix output block for the lounge Drag the blue preset icon lu appears and drop it on the blue rectangle for the Mute All Preset in the All Presets dialog Repeat for the other two HAL1x output blocks 11 CHAPTER 3 Example HAL1x Configuration 12 Test this by activating and deactivating the Mute All Preset from the All Presets dialog All three HALIx output blocks mute when the preset is active and un mute when the preset is not active LAN Watt TH FEST 1 l 7 O Ce pj e dor yee a emer oaia pair HALI ralog Oupa Por 7 Line Level Select Toggle Command Label Value Enable Number A o Ei Wal toggie Coning i e Wall Toggle Wall Toggle C e C e a K Ps Mute All Toonle Contra 4 i Mute All F Mute All Gan F Of Mm Ire oe ee Crate eil g Ran GREETS Hu fe kee Dest Pore 2 Live y HAL ty Ardo Outer Por 3 Line Toggle selector Command Level Level Acre Preset Hame POS Mine All Preset d Te o Cnt ETT Preset Duplicate Movet F Of Min Acte Presets lnwert Parity Actre Preset ScraichPad i Now we ll add a Command control to reset all outputs to a default operating state In the All Presets dialog click on the Command tab Create a new command preset by clicking on the Preset button Rename this new preset to Default Level Preset In the
47. gs A Obtain an IP address automatically IP address Subnet mask Default gateway Obtain DNS server address automatically Use the following DNS server addresses Preferred DNS server 8 Alternate DNS server Pl Validate settings upon exit PCs are frequently setup to use dynamic IPs but a static IP is preferable if you want to use your PC in place of a HAL during development The controller tries to connect to a TCP server your PC in this case at a specific IP address If your PC has a dynamic IP address assigned to it that address may change if it 1s disconnected from the network or the DHCP lease expires You also probably do not want to configure your PC with the same static IP as your HAL in the event that both are connected to the same network Control system networks are typically private networks with no direct route to the Internet except through a gate way or proxy server Certain IP address ranges are reserved for private networks 10 0 0 0 to 10 255 255 255 is one of those address ranges Start with a small self contained network Plug your Halogen PC controller XPanel PC and HAL into the same Ethernet switch and assign each one a unique static IP in the 10 0 0 0 network Ethernet Units This section shows you how to set up the Ethernet Units in the Crestron system configuration so that the examples work 20 CHAPTER 4 Integrating Crestron Control Systems with HAL File Edit Options View Project Bookmarks
48. gt 2 stri Jazz Radio Button Ni lt Saiai gt lt Sai gt el Reggae Radio Button esa182 gt lt s81 gt 000 seh TE str smooth Radio Button lt S8281 gt lt Sh2 gt BIG Boost Radio Button l lt SR282 gt lt Sh2 gt Sbhp Default_Command Button lt C amp 3 gt E Soften Radio Button E MUTE Toggle Of sel lt T amp 480 gt lt T amp 4 gt MUTE Toggle ON sel lt T8481 gt lt T84 gt WALL Toggle Of sel lt T amp 580 gt lt Tk5 gt WALL Toggle ON sel eT amp S81 gt lt T amp 5 gt sti2 eS81a0 gt j ae 21113 lt S amp 1 amp 1 gt ME stri4 SE152 gt 50 shih lt S8280 gt Barn strig lt S amp 281 gt S SMOOTH sel str17 epp s BOOST sel strig TRAB0 gt MUTE Toggle Of stri9 etadi IMUTE Toggle ON strz0 TES5E0 gt WALL Toggle Off str21 lt 1 amp 581 gt WALL Toggle_ON Double click the Serial I O and Serial Send symbols under Logic in the Program View to bring up their details Clicking a selector radio button on the XPanel sends a message string to Halogen HAL These set selector mes sages are comprised of a selector control type HAL control number and value The valid set selector messages for the source selector in this program are lt S amp 1 amp 0 gt lt S amp 1 amp 1 gt and lt S amp 1 amp 2 gt The valid set selector messages for the PEQ selector in this program are lt S amp 2 amp 0 gt lt S amp 2 amp 1 gt and lt S amp 2 amp 2 gt The controller also requests HAL selector
49. his to HAL to request rent enable lt TE amp n gt the current enable value of a value of Tog n is the control number Toggle external control gle external control number 4 Send this to HAL to set the enable for a Toggle external Set enable message where control to a new value lt TA amp 4 amp 0 gt n is the control number HAL sends this set the enable l value for Tog RE v is the enable value 1 in response to a get gle control enable message number 4 to 0 whenever an enable disabled for a Toggle external control changes value The values for v are 0 disabled or 1 enabled 53 Selector Controls CO CC ee Message Format lt S amp n gt lt S amp n amp v gt lt SL amp n gt lt SL amp n amp x gt APPENDIX A HAL External Control Message Protocol Get selection message where n is the control number Set selection message where n is the control number v is the control value The range for v is 0 to one less than the number of selections Get selection link message where n is the control number Set selection link message where n is the control number x is the number of selections 0 indicates that no selections are available 1 e the selector link is inactive Send this to HAL to request the current value of a Select external control Send this to HAL to set a Select external control to a new value HAL sends this
50. icking on the Kai button 3 Change the name of this new control to Lounge Level Control and set its number to 6 4 Open the property dialog for the lounge output block HAL1x Line Output 1 5 Link the new Level external control to the level control in the Line Output block property dialog Do this by dragging the link icon in the External Control Systems dialog to the right of the control name and dropping it on the link icon for the Line Output Block s level control CRESTRON CONTROL SYSTEMS GUIDE 6 Change the Label for the Lounge Level Control Lounge Volume The dialogs appear below as follows TEXTO Create aed ect GE SE control Sy eter Level Select Toggle Command Name Label Y Enable Number ll Lounge Level Control ei Lounge Volume D S C Ge 1 O art AE A gt HALT Analog Output Part 1 Line Gain T Off Min lnvert Mute ci In a Room Combine application end users typically need to let the audio system know when they open or close a movable wall To create a Toggle control for this 1 Open the Room Combine Processor property dialog 2 Drag both Room A and Room B onto the Layout amp Control area and arrange them so that they are next to each other 3 Add a movable wall between them by dragging the movable wall icon between the rooms until the wall highlights then dropping the wall to create a wall toggle control 4 In the External Control Systems dialog click on the Toggle tab 5
51. information on the HAL external control message protocol and how to use a telnet client to monitor and troubleshoot the oper ation of a control system at the message protocol level The guide is designed to be used in conjunction with the files found in the Crestron Support Package The contents of this support package include e CrestronControlSystems Guide pdf The Crestron Guide pdf file e ControlSystemSample hal Halogen configuration file intended for loading in Halogen or your HAL1x e Rane HAL smw SIMPL Windows program project file e Rane HAL TP vtp VisionTools Pro e touch panel project file CHAPTER 1 Overview e Rane HAL Level Processor usp SIMPL user module source file e Rane HAL Level Processor ush Compiled user module The Crestron Support Package is installed with the Halogen software and can be accessed from the Windows Start Menu under Rane Corporation gt Halogen gt Guides gt Crestron If you want to access the files directly they are available on the product DVD or from the Halogen install directory e Windows 8 7 or Vista C Program Files x86 Rane Corporation Halogen Guides Support Pack ages Crestron directory e Windows XP C Program Files Rane Corporation Halogen Guides Support Packages Crestron direc tory You can also download the most up to date version of this support package from the Rane website http rane com hal Stardraw Control Systems Guide This guide includes an introduct
52. ion gt TCP IP Client e Crestron Software Applications gt e Control PC Interface e Touchpanels gt Touchpanels Ethernet gt XPanel To add an e Control and XPanel to the list of Ethernet Units remember to drop them on the Ethernet slot of the large controller device block in the upper System Views pane Double click the TCP IP Client icon in Ethernet Units to bring up its Device Settings dialog Select the IP Net Address tab The Default Address field should contain the IP address of your control systems server This server could be running on your HAL or it could be running on your PC when Halogen is open The example program file comes with the Default Address set to 10 0 0 6 Change this address to match the IP address of your PC for now 21 ANE CRESTRON CONTROL SYSTEMS GUIDE Double click on the e Control PC Interface icon in Ethernet Units to bring up its Device Settings dialog Select the IP Net Address tab The Default Address field should be set to 127 0 0 1 This is the loopback address of any PC so there should be no reason to ever change it An e control is what enables a PC to act like an Ethernet touch panel Remember the e control s IP ID of 4 You will need it for the XPanel Project Properties dialog in Vision Tools Pro e Double click the XPanel icon in Ethernet Units to bring up its Device Settings dialog Select the IP Net Address tab The Default Address field should contain the IP address of the PC where the XPanel
53. ion to using external control systems with HAL It also discusses an exam ple HALI configuration and an example Stardraw Control application and driver that communicates with a Halogen HAL Control Server In addition an appendix is included with reference information on the HAL external control message protocol and how to use a telnet client to monitor and troubleshoot the oper ation of a control system at the message protocol level The guide is designed to be used in conjunction with the files found in the Stardraw Control Support Pack age The contents of this support package include e StardrawControlSystems Guide pdf The Stardraw Control Guide pdf file e ControlSystemSample hal Halogen configuration file intended for loading in Halogen or your HAL1x e HALI Stardraw Example Project s03 Stardraw Control Project e HATT Example Driver cs Stardraw HATT driver source code This is part of the Stardraw Control Project but 1s included separately here for reference The Stardraw Control Support Package is installed with the Halogen software and can be accessed from the Windows Start Menu under Rane Corporation gt Halogen gt Guides gt Stardraw Control If you want to access the files directly they are available on the product DVD or from the Halogen install directory e Windows 8 7 or Vista C Program Files x86 Rane Corporation Halogen Guides Support Pack ages Stardraw Control directory e Windows XP C Program Files R
54. ior alluded to earlier Now watch the Active state of the Mute All Preset in Hal ogen as you click the Mute All button on the XPanel Lastly toggle the Mute All Preset from Halogen to see that the Mute All button and Lounge slider on the XPanel respond NOTE Refer to Appendix B Using PuTTY to Test External Control Systems on page 59 for help with debugging if the system does not behave as described here 31 JANE CRESTRON CONTROL SYSTEMS GUIDE Wall Toggles This example demonstrates how to get a toggle button on a touch panel to open and close a movable wall in a Hal ogen HAL Room Combine block The example Halogen configuration file contains a Room Combine block with two rooms A and B The movable wall in between these two rooms is linked to a Control Systems toggle control named Wall Toggle Control Toggling this HAL control opens and closes the wall koom Combine Room Combine Layout amp Control Room Processors Available Rooms Room Combinations Open the ControlSystemSample hal example configuration file in Halogen then open the External Control Sys tems dialog and select the Toggle tab The Value checkbox for the Wall Toggle Control reflects the current state of that HAL toggle control 32 CHAPTER 4 Integrating Crestron Control Systems with HAL FAREI AA eee eee oe Pes ii LAEI Po ere ea PANEL Cer ranks Documents Free HAL Creiren i i Ele Sea rn Layout Display Vpteen Tool Yimdow Help sip E B S
55. is example demonstrates how to get a slider on a touch panel to manipulate the level on a HAL output The example Halogen configuration contains a HAL line output wired to a lounge The remaining HAL line outputs go to rooms A and B The level on the lounge output is linked to a HAL Control Systems level control named Lounge Level Control Adjusting the HAL level control alters the level a NS KH HERE W IR eti TA Create and edit controls for ute in external control ystems Level Select Toggle Command Name Label Enable Number d j 7 D em p ES E Lounge Vo Lannie kB e D me Open the ControlSystemSample hal example configuration file in Halogen Then open the External Control Sys tems dialog and select the Level tab The percentage shown in the Value column for the Lounge Level Control is the live value of that level in the system Drag the level slider in that dialog and the number shown in the edit field changes accordingly Open the Rane HAL TP vtp project file in Vision Tools Pro e Then open the Sound page window to view the example touch panel design Select the Lounge slider on the right side of the Sound page window Notice that the Analog Touch Feedback Join number for this slider is set to to match the an fl input and an_actl output on the XPanel symbol in the program The slider s output is routed to the LEVEL input of the Rane HAL Level Processor The slider s input is driven by the LEVEL _ fb output of the Rane HAL Lev
56. it on the blue Add rectangle for the Soften Vocals preset 9 Set the PEQ frequency to 1589 and add the PEQ block to the Smooth preset 10 Set the PEQ frequency to 393 the Gain to 2 0 and add the PEQ block to the Boost Bass preset 11 Test the preset selector by clicking on the Active radio buttons and observing the PEQ change 12 In the External Control Systems dialog click on the Select tab 13 Create a new Selector external control by clicking on the button 14 Rename this new control to PEO Selector Control and set its number to 2 13 CHAPTER 3 Example HAL1x Configuration 15 Link the PEQ Selector Control to the PEQ Preset Selector control in the All Presets dialog Do this by dragging the link icon in the External Control Systems dialog to the nght of the control name and dropping it on the link icon for the PEQ Preset Selector control 16 Change the PEQ Selector Control s Label to Tone The dialogs appear below as follows emal _COntrol Sterns Coane andl ect Corp fae wae in bernal Castrol spite Level Select Toggle Command Mame Label Wale Enable Number Source Jerr Tone Soften Vocal PEO Selector Control Ji Ei salten Vaca weth Locos Bars E PE pr e Cra See Sch Tie Gezei i Pr parao EG 1 Fiery Toggle Selector Command Response Wire z T Ma grutude PEQ Preset Selector d 7 Phase e zet F Ve Arme Preset Name Selection Name E Compos
57. ite Soken Joos d Soften Vocals Smogth ME e T Imdireichual EI Filter 1 VC Boost bas TT Beet Base Rag rd ede dE Include Ne Selection de Order A F Selector Preset Duplicate Move 7 Add Filter 18 Wl d HP PPOEPLELIL PPP PTI ICI DET SCO SOL Priceity Active Preset ScratehPad Frequency HI Flatten AU 1 eather Wo al a AN A cut MA Cen 2000 lar Barchindih Show Table View Bypass All Wow that s the whole configuration Be sure to save your configuration before quitting Halogen 14 ZANE CRESTRON CONTROL SYSTEMS GUIDE Configuration Summary The example configuration provides the following external controls l 15 A Selector for lounge program source control number 1 There are three selections Classical Jazz and Reggae A Selector for lounge tone PEQ control number 2 There are three selections Soften Vocals Smooth and Boost Bass A Level for lounge volume control number 6 This changes the output block s level for the lounge A Toggle to mute all audio outputs control number 4 This mutes all output blocks and sets their levels to Off While setting the levels is not necessary we ve included it here to cause the lounge output level to change so the Halogen HAL Control Server will send a set level message A Toggle to open and close the wall of a room combine block control number 5 A Command to reset audio outputs
58. mes of certain toggle 25 ANE CRESTRON CONTROL SYSTEMS GUIDE signals In that context the toggle is viewed as a 2 way selector with a toggle ON selection and a toggle Off selec tion Toggles KT Togo OA ith TAuITE Toppe OUT Ae Serial VO Set Reset Latch Wal eege huron l ri MITE _Toggle_ OH E WALL Toggle OI Ae i MATE Toppe OO WALL logge La ve Set Reset Latch SOL PREE out WALL Toppe Ohi OA This section explains how to integrate HAL toggle controls with buttons on an XPanel by examining a couple of touch panel applications a preset toggle button and a wall toggle button We start by breaking down the logic symbols and signal flow for the HAL toggle controls Then we examine how to bind the HAL toggle controls to toggle buttons in the touch panel user interface Toggles in a HAL system have only an on or off state They are represented as checkboxes in the Halogen soft ware and DR remotes Because toggles only have two states they are modeled as digital signals in SIMPL The example program has symbols to deal with toggle button presses on a touch panel and toggle messages from a Hal ogen HAL Trace through the Toggle Control Signal Flow diagram to get an overview of how these symbols work together before we look at them up close Open the Rane HAL smw program file in SIMPL Windows There are two HAL toggle controls in this program uniquely identified by HAL control numbers 4 and 5 These H
59. message type When sending messages to the Halogen HAL Control Server it e Allows white space anywhere in the message which includes space tab carriage return and line feed char acters e Ignores all characters outside of a message that is before the start character and after the end character e Ignores the case of alpha characters you can use upper or lower case in any combination Halogen s External Control Systems dialog defines the unique control number for each control which is always n in the message table below For example suppose you have defined a Level control in the Halogen External Con trol Systems dialog as follows SNP TT Ei io ee 5 E LE TE Create and edit controls for use in external control Gd SA Level Select Toggle Command Name Label Value Enable Number l ie Level 1 METE In this instance the control number is 5 and that is what you use in the set level and get level messages when developing external control systems In this case the get level message for this control 1s lt L amp 5 gt Details of external control messages In the following tables normal characters are literal while bold characters are variable and defined in the descrip tion 49 APPENDIX A HAL External Control Message Protocol All Controls lt gt request the current Send this to HAL to request the values of all lt gt Get all values message l current values of all con
60. n directory You can also download the most up to date version of this support package from the Rane website http rane com hal NOTE You do not need to connect your controller to an actual HAL in order to test your control system A PC running Halogen can simulate all the feedback your controller would get from a HAL running the same configuration This guide walks you through the configuration of a Crestron TCP IP client e Control and XPanel It then describes how to wire logic symbols for serial communications with a Halogen HAL Control Server using a Serial Buffer and Serial I O After explaining our general communications strategy we then turn our attention to the HAL s specific control types The HAL system has four types of controls toggles commands levels and selectors All four are accessible to external TCP IP clients like a Crestron controller This guide covers each of these control types in depth one by one First we dive into the logic symbols and signal flow for the control type Then we use the control type in some touch panel applications The applications are e Toggle button to activate and deactivate a preset e Toggle button to open and close a wall in a room combine block e Command button to assert a preset e Slider to adjust the level on an output 16 CHAPTER 4 Integrating Crestron Control Systems with HAL e Radio buttons to select between input sources e Radio buttons to select between presets
61. n file contains a Parametric EQ block Different EQ filter settings for this block are saved to different presets One preset softens vocals another smooths out the mid range and a third boosts the bass These three presets belong to the same PEQ Preset Selector This selector is linked to a HAL Control Systems selector control named PEQ Selector Control Switching selections on the PEQ Selector Control switches the active preset in the PEQ Preset Selector Ch EI Cor tre 1 po ny 1 ate and edit controls for use in external control systems Cre Level Select Toggle Command Name Label Value Enable Number E wm BEE BE k 1 source hi Classical Tone Soften Vocals Soften Vocals Smooth Boost Bass Open the ControlSystemSample hal example configuration file in Halogen Then open the External Control Sys tems dialog and select the Selector tab The selected item in the Value column for the PEQ Selector Control is the preset currently selected by that selector in the system The set of radio buttons also reflects the current selec tion Select a different item for the PEQ Selector Control to choose a different PEQ preset Open the Rane HAL TP vtp project file in Vision Tools Pro e Next open the Sound page window to view the example touch panel design Select the circular Soften Vocals radio button in the Sound page window Notice that the Digital Press Join number for that radio button is set to 70 to match the fb 0 input and press 0 ou
62. ogs button on the top bar of the XPanel details window The Rane HAL Level Processor for the Lounge Level Control maps to the an_fb input and an_act output on the XPanel The incoming feedback signal is named Lounge Level fb The outgoing touch panel slider signal is named Lounge Level Slider The lt L amp 6 gt get level message appears in the string parameter of the Serial Send symbol that is triggered when ever the TCP IP Client connects to Halogen HAL Requesting the level value on connect ensures that the slider on the XPanel is in sync with the live level value on Halogen HAL The Rane HAL Level Processor is a user module written in SIMPL Right click on it under Logic in the Pro gram View and select Edit User Module to view its source code The user module parses and encodes set level 38 CHAPTER 4 Integrating Crestron Control Systems with HAL messages and converts from Crestron analog to HAL level values and back A full listing of the user module source code is available in Appendix C Crestron Source Code on page 65 Because the Rane HAL Level Processor is a user module you can add multiple instances of this symbol to your own programs for more HAL levels First drag it from the Symbol Library and drop it into your Program View as you would any of the stock logic symbols Then initialize the CONTROL NUM input and route the rest of the ins and outs to the XPanel e control TouchPanel and TCP IP Client Sliders Th
63. ol numbers appear in the Selector tab of Halogen s External Control Systems dialog as Source Selector Control and PEO Selector Control PEQ stands for parametric equalizer 41 CRESTRON CONTROL SYSTEMS GUIDE Slot 05 1P ID 04 XPanel XPanel Rn va Is XPanel Digitals MUTE Toggle ON fb fb1 press1 Mute Toggle Button k WALL Toggle ON fb fb2 press2 Wall Toggle Button fb3 press3 Default_Command_Button fb4 press4 Default_Command_Button fbS press5 CLASSICAL sel fb fb6 presse IEN EERSTEN JAZZ sel fb GD press BEER iced REGGAE sel fb 1b8 press E ls tg fba Dress SOFTEN sel fb 1010 press10 ECU Ti SMOOTH_sel_ fb 1b11 press11 Elie ity BOOST sel_fb fb12 press 12 RAE e 1013 press13 press 14 Ab press15 D CONNECTED Double click the XPanel symbol under Slot 05 of the MC2E under Logic in the Program View to bring up its details The radio buttons for the two selectors are divided into two groups on the XPanel The Classical Jazz and Reggae radio buttons assigned to digital signals 6 7 and make up the Source selector group The Soften Smooth and Boost radio buttons assigned to digital signals 70 11 and 72 make up the Tone selector group 42 CHAPTER 4 Integrating Crestron Control Systems with HAL ES 5 3 Serial VO FROM DSP1 nes IP CONNECTED enable STO _ DSP2 Classical Radio Button l lt S81R0 gt lt Sh1
64. on Took Window Help QcOS 6 B B 8 Simm o GEO t wera retire Face Cok jmp f ze 7 b AARAA GLEE emp D AA RE A AS p w i i Fh il cb dh gt K i GD CET COD DH E ODC OO DEER EI Synchronize States Descnptsan Page Flap Ty pE Suppress Key Click Ho Object Hamas mulier Mode Mormentary Template Data O Mute All O Wall Open Toggles Type select a digital press join from the bat bon by F ge f e i i Ckckeu or click A bo automatically assign the eure eect a next available aer os choose a reserved join number AGA ILAA i E E Curpor 127 256 Ree Fip Noe iot 1 Open the Rane HAL TP vtp project file in Vision Tools Pro e Next open the Sound page window to view the example touch panel design Select the Mute All button in the Sound page window Notice that the Digital Press Join number for the Mute All button is set to 7 to match the fb1 input and pressi output on the XPanel symbol in the program The button will appear raised when it is in its inactive state and depressed when it is in its active state Launch the XPanel and verify that the Connected status indicator shows you are connected Refer to the Trou bleshooting on page 47 section if it the status indicator says Disconnected Click the Mute All button on the XPa nel on and off The touch panel button will remain in its new active or inactive state after you release the mouse button This is the latching behav
65. onal input and set the input names to Classical Jazz and Reggae Also delete room C from the Room Combine Processor by clicking the red X in room C Wire these together with your I O blocks so that your processing map looks like this JANE CRESTRON CONTROL SYSTEMS GUIDE HAL 1x Mic Line MicLine Input 1 sa Channel 1 Output HAL1x Mic Line Mic Line Input 2 ae Channel 2 Output d HALI Mic Line MicLine Input 3 a Channel 3 Output HALI Mic Line hic Line Input 4 ae Channel 4 Output d HAL1x Mic Line Mic Line Input 5 ae Channel 5 Output Selector 1 t Classical Output e Kon Pol Program Bus Distributed Program Bus Kon lt Add gt Parametric EQ x 1 Parametric Equalizer 1 Line Output 1 Output lt Input Channel 1 ma Room Combine Room Combine 1 Distributed Program Bus Auto Mier Line Output 2 Input Channel 2 ma Line Output 3 Input Channel 3 ee The top row of blocks provides audio for a lounge that has three program source inputs and some PEQ processing and the bottom row is a simple room combine configuration Next we ll add some external controls using the External Control Systems dialog and link them to some of the controls available in the processing blocks we are using First well create a control for the lounge input program selector 1 Just above the upper left of the Processing Workspace click on the Control Systems button
66. oper ation of a control system at the message protocol level The guide is designed to be used in conjunction with the files found in the AMX Support Package The con tents of this support package include e AMXControlSystems Guide pdf The AMX Guide pdf file e ControlSystemSample hal Halogen configuration file intended for loading in Halogen or your HALIx e Rane HAL apw NetLinx Studio program project file e Main axs NetLinx program source file e Rane HAL TP TP4 TPDesign4 touch panel project file The AMX Support Package is installed with the Halogen software and can be accessed from the Windows Start Menu under Rane Corporation gt Halogen gt Guides gt AMX If you want to access the files directly they are available on the product DVD or from the Halogen install directory e Windows 8 7 or Vista C Program Files x86 Rane Corporation Halogen Guides Support Pack ages AMX directory e Windows XP C Program Files Rane Corporation Halogen Guides Support Packages AMX directory You can also download the most up to date version of this support package from the Rane website http rane com hal Crestron Control Systems Guide This guide includes an introduction to using external control systems with HAL It also discusses an exam ple HAL1x configuration and how to set up a Crestron controller and virtual touch panel to communicate with a Halogen HAL Control Server In addition an appendix is included with reference
67. or external control changes value lt SE amp 4 gt request the cur Get enable message where Send this to HAL to request e le Se lt SE amp n gt the current enable value of a E Select i n is the control number Level external control Ge nal control number 4 Send this to HAL to set the enable for a Selector external Set enable message where control to a new value i lt SA amp 4 amp 0 gt set n is the control number HAL sends this EE GEET lt SE amp n amp v gt eae E BE Pa 1 in response to a get for Selector con enable message trol number 4 to The values for v are 0 disabled gt 0 disabled or 1 enabled Whenever an enable for a Selector exter nal control changes value S6 ANE CRESTRON CONTROL SYSTEMS GUIDE Command Controls Send this to HAL to fire a Command external control ZO RAS Fie Command message where lt C amp n gt l HAL sends this whenever a Command con EE Command external control trol number 4 fires lt CA amp 1 gt Get label message where Send this to HAL to request Ee lt CA amp n gt the current label value ofa n is the control number Command external control op Command external control number 1 Send this to HAL to set the label for a Command external control to a new value Set label message where lt CA amp 1 amp Flatte HAL sends this n gt set the lt CA amp n amp string gt n is the control number Reeg SE string is the label f
68. or the control label message trol number 1 to 2 whenever a label for Flatten a Command external control changes value lt CE amp 4 gt request the cur Get enable message where Send this to HAL to request rent enable lt CE amp n gt the current enable value ofa value of Com n is the control number Command external control mand external control number 4 Send this to HAL to set the enable for a Command external Set enable message where control to a new value lt CA amp 4 amp 0 gt n is the control number HAL sends this set the enable value for Com SON v is the enable value I in response to a get mand control enable message number 4 to 0 whenever an enable disabled for a Command exter nal control changes value The values for v are 0 disabled or 1 enabled 57 APPENDIX A HAL External Control Message Protocol Communications Monitoring lt PING gt Pine mesae Send this to HAL to request a lt PING gt pong message It is not meaningful to send this message to HAL lt PONG gt Pong message HAL sends this whenever it lt PONG gt receives a ping message from an external control system 58 APPENDIX B Using PuTTY to Test External Control Systems The Halogen HAL external control message protocol is ASCII text based which means that you can use a standard telnet client to connect to the control server and exchange messages This is often useful when developing and test
69. resets dialog click on the Toggle tab Add a new toggle preset by clicking on the Preset button Rename this preset to Mute All Preset In the External Control Systems dialog click on the Toggle tab if it is not already displaying the toggle controls at E 6 Add a new Toggle external control by clicking on the button and set 1ts number to 4 7 Rename this new control to Mute All Toggle Control 10 CRESTRON CONTROL SYSTEMS GUIDE 8 Link the new Mute All Toggle Control to the toggle control for the Mute All Preset Do this by dragging the link icon in the External Control Systems dialog to the nght of the control name and dropping it on the link icon for the Mute All Preset s toggle control 9 Change the Label for the Mute All Toggle Control to Mute All The dialogs appear below as follows i KT bi Create and ede contre for ure in external contre Gerigemg Lee Select Toggle Command Name Label Value Enable Number 7 Wall Toggle Control 27 Wall Toggle Wall Toggle T d EA Mute All Toggle Control M Mute All Mute All a fA d Paff eer ee Create and ch rte presets Toggle Selector Command Active Preset Name amp Mute All Preset I LE Preset Duplicate Movet Y Actree Presets Priority Actwe Preset ScratchPad Room ROU Room A 1 10 Open the three HAL1x output blocks set each of the mute checkboxes to checked muted and set their level controls all the way down Of
70. s lt T amp 23 gt request the cur Get toggle message where Send this to HAL to request eee eet ae lt T amp n gt the current value of a Toggle RE as n is the control number external control Oggie exter nal control number 23 Send this to HAL to set a Tog gle external control to a new Set toggle message where value lt T amp 23 amp 1 gt t th l n is the control number WAT condor e Si e e ue lt T amp n amp v gt of Toggle v is the control value 1 in response to a get external con toggle message trol number 23 The values for v are 0 un checked or 1 checked 2 whenever a Toggle external control to 1 checked changes value 52 CRESTRON CONTROL SYSTEMS GUIDE lt TA amp I gt request the cur Get label message where Send this to HAL to request rent label lt TA amp n gt the current label value of a Tog value of Tog n is the control number gle external control gle external control number 1 Send this to HAL to set the label for a Toggle external con trol to a new value lt TA 18Mut Set label message where e gt set the HAL sends this label value for lt TA amp n amp string gt n is the control number 1 in response to a get Toggle control string is the label for the control label message mune l to 2 whenever a label for a ER Toggle external con trol changes value lt TE amp 4 gt request the cur Get enable message where Send t
71. s configuration using only inputs and outputs available on the HAL1x so that you can load and apply this configuration to any HAL1x without having to attach and configure other devices such as RADs or DRs Creating the Example Configuration below shows how to build the complete configuration from scratch Of course we also provide the configuration file for you so you don t have to go through all of the work but it s your choice You can either follow the directions below to create the configuration or open the file we provide and use the instructions below to learn about what s in the configuration Alternatively you can just read the Configuration Summary on page 15 to learn what external controls this con figuration provides Creating the Example Configuration To get started all of the work is done in the processing workspace so click on the Processing tab in the upper right section of the Halogen application Click on the tab for the I O palette and drag the first five HAL1x Mic Line inputs from the palette and drop them on the left side of the processing map In a similar way drag the first three HAL1x Line Outputs from the palette and drop them on the nght side of the processing map Next fill in the middle processing area by clicking on the DSP palette tab and dragging four processing blocks to the processing map Parametric EQ Distributed Program Bus Room Combine and Selector For the selector block create one additi
72. ss1 Mute_Toggle Button WALL Toggle ON fb press Vall Toggle Button press3 Default Command Button fe4 pressa Defauh_ Command Button p ts press5 CLASSICAL sel fb th press6 Classical Radio Button Jaze sel E fer press Jazz Radio Button REGGAE sel fb g press Reggas Radio Button i feo press SOFTEN s l fb IO press 10 Soften Radio Button SMOOTH sel fo 16 11 pross11 Smooth_ Radio Button BOOST sel fb 1612 press12 Boost Radio Button A 1613 pressi3 IP_CONNECTED mis press 14 015 press 15 The e control PC interface enables an XPanel to connect to the LAN that its PC host is on The e control Touch panel symbol looks just like an Ethernet Touchpanel symbol in terms of ins and outs All of the signals that are on the XPanel symbol should be applied to the same inputs and outputs on the e control Touchpanel This allows signals to flow out from the XPanel through the e control over the LAN to the controller and vice versa Signal Names A few signal naming conventions are used throughout the example program It helps to familiarize yourself with them before delving further into the logic and signal flow of the program A button press signal from a touch panel output has the Button suffix at the end of its name A button feedback signal to a touch panel input has the _fb suffix at the end of its name Take the Wall Open button that appears on the XPanel for example The signal from its press2 output is named Wall Toggle
73. stem Of course because the actual hardware is not present you cannot process audio or use physical devices such as Digital Remotes NOTE To use the Control Server built into Halogen connect to port 4996 on the TCP IP address of the PC that is running Halogen The other way to use the Control Server is to connect to a HAL DSP Processor itself This server is always avail able on a HAL at port 4996 on any of its TCP IP addresses Once you have created and applied a HAL con figuration that contains external controls these controls are available to your external control system via the Control Server We recommend that you configure a static IP address on your HAL when using the HAL Control Server so that the server is always available to your control system at a stable address E NOTE To use the Control Server built into HAL connect to port 4996 on the TCP IP address of the HAL ZANE CRESTRON CONTROL SYSTEMS GUIDE Communicating with a Halogen HAL Control Server Once connected to either the Control Server built into Halogen or to the server in an actual HAL your external control system communicates with the Control Server using the HAL system External Control Message Protocol This is an ASCII text based protocol that allows one or more control systems to access the external controls in your HAL configuration Appendix A HAL External Control Message Protocol on page 49 fully defines these messages but an example would be lt L amp 4 amp
74. t n is the control number Send this to HAL to increment or decrement a Level external control Send this to HAL to request the current label value of a Level external control HAL sends this lt L amp 1 amp 105 gt increment the value of Level external control number 1 by 10 5 lt L amp 2 amp 234 gt decrement the value of Level external control number 2 by 23 4 lt LA 1 gt request the cur rent label value of Level external control number l lt LA amp 1 amp Volume gt set the label value for Level control 1 in response to a get string is the label for the control label message number 1 to Volume 2 whenever a label for a Level external con trol changes value 51 APPENDIX A HAL External Control Message Protocol lt LE amp 4 gt request the cur Get enable message where Send this to HAL to request Ee lt LE amp n gt the current enable value ofa EE i n is the control number Level external control See IS control number 4 Send this to HAL to set the enable for a Level external Set enable message where control to a new value l lt LA amp 4 amp O gt set n is the control number HAL sends this EG EE d lt LE amp n amp v gt amable nal 1 in response to a get for Level control enable message number 4 to 0 The values for v are 0 disabled A EE E disabled or enabled for a Level external control changes value Toggle Control
75. tals MUTE Toggle ON fb fot press1 Mute Toggle Button WALL Toggle ON fb b2 press2 Vall_ Toggle Button fos press3 Default Command Button rz G ss iietaub Command Button a pross5 A CLASSICAL sel fb P press6 Classical Radio Button JAZZ sel fo b7 press Jazz Radio Button REGGAE sel fb 169 presse Rengas Rade Button ha press SOFTEN sel fb GA press10 So en Radio Button SMOOTH sel fb Di press11 Smooth_Radio Button i BOOST sel fb dp press12 Boost Radio Button 613 press13 IP_ CONNECTED lia press14 A press 15 k Pa There is one HAL command control in this program uniquely identified by HAL control number 3 This control number appears in the Command tab of Halogen s External Control Systems dialog as Default Command Con trol Whenever the Default Level button on the XPanel is clicked the Serial I O sends a message string to Hal ogen HAL These command messages contain a command control type and a HAL control number The only valid command message for the HAL command control in this example is lt C amp 3 gt Lal NOTE Refer to Appendix A HAL External Control Message Protocol on page 49 for more information on command messages When a client sends a command message Halogen HAL echoes it back to all its other clients The Serial I O in this program currently ignores unsolicited lt C amp 3 gt command messages but you can add a string parameter to parse them if you want your touch panel to
76. the external controls can link to any other linkable control in a con figuration you have tremendous flexibility in the access that you provide to end users and seamless integration of your control system with internal controls such as those in DSP block parameters and Rane Digital Remotes Each control that you configure for external access includes a unique number that allows external control systems to identify each control For example you might define a level control to be number while a toggle control is number 2 Connecting to a Halogen HAL Control Server The HAL system contains a Control Server to provide a way for your control system to connect and use the con figured external controls To integrate your external control system with a HAL system your control system simply connects to the Control Server over TCP IP In the spint of allowing you to configure and test your HAL system as much as possible without needing actual HAL hardware present there are two ways that you can connect to a HAL Control Server to develop test and use your external control system First when developing and testing your system the Halogen software includes the Control Server which runs whenever Halogen is not connected to a HAL Even though the configured HAL system hardware is not present using the Control Server built into Halogen allows you develop your configuration including all of the external controls and test them with your external control sy
77. then select External Controls to open the External Control Systems property dialog 2 In the External Control Systems dialog click on the Select tab 3 Create a new Selector control by clicking on the button 4 Change the name of this new control by clicking the edit icon and entering Source Selector Control followed by the Enter key Set its number to 6 Double click the Selector block in the Processing Map to open its property dialog CHAPTER 3 Example HAL1x Configuration 7 Link the new Selector control in the External Control dialog to the selector block s selector control Do this by dragging the link icon Figg in the External Control Systems dialog to the right of the control name and dropping it on the link icon Eed for the Selector Block s selector control 8 Change the Label in the Source Selector Control to Source Together the selector property dialogs are as follows WIE Lea o L 1 d L T pou JS 7 d Create and edit control for use in extemal control pyrtems Level Select Toggle Command Mame Label Value Enable Number Source Jagr Reggae Selector Classical A E Jazz Jazz amp Reggae Reggae Y our external control system can now get and set the lounge input source using the External Control Message Pro tocol Next we ll add a control for the lounge volume level 1 In the External Control Systems dialog click on the Level tab 2 Create a new Level control by cl
78. tput on the XPanel symbol in the program The Digital Press Join numbers for the other two tone selector radio buttons are and 2 A radio button will appear blue when it is in its active state and blacked out when it is in its inactive state 46 CHAPTER 4 Integrating Crestron Control Systems with HAL UA Crestron Vision Toode R Pro e MPANIEL Ci lsers Free Documents Rane HAL Crestron Sampie Rane HAL TP vtp Co e fame File Edi Drew Leyoa Display Options Took Window Help sd S EB B S amp thea vie BAH k b AAAS A GG Ges SUN BAA AE E a GE K Active Face Color el Pa DS bk O b ea i i 8 8 0 8 a e en GA Vie e JW Sound CAUsers Frank Documents Rane HAL Crestron Sampl TS Property Name Property Vale My Rane HAL TP El Burton D Sourd DK Synchronize States Ye Description ofal Peer Jom 7 Page Flip Menej Page Flap Type Page Ove o e S ft V Ssuppress Key Click He i Soften Vocals objet Nur o B O Srila Moda Mecngotapa Template Date Cursor 450 256 Page Fle None joni 10 Launch the XPanel and verify that the Connected status indicator shows that you are connected Refer to the Troubleshooting below section if it the status indicator says Disconnected In Halogen click on the Presets icon in the Processing Workspace toolbar to bring up the All Presets dialog Choose the Selector tab in that dialog and expand th
79. trols controls in the con figuration Level Controls lt L amp 1 gt request Get level message where Send this to HAL to request the current value lt L amp n gt the current value of a Level of Level external n is the control number external control control number 1 Send this to HAL to set a Level external control to a Set level message where new value lt L amp 1 amp 456 gt n is the control number E EE DEE E lt L amp n amp v gt Level external v is the control value 1 in response to a get sandra lambert The range for v is 0 to 1000 cor EEN to 45 6 responding to 0 to 100 0 2 whenever a Level external control changes value 50 JANE CRESTRON CONTROL SYSTEMS GUIDE Increment Decrement level mes sage where n is the control number indicates increment indicates decrement v 1s the amount to increment or decrement the current control lt L amp n amp v gt value The range for v is 0 to 1000 cor responding to 0 to 100 0 lt L amp n amp v gt NOTE When an increment or decrement message would result in setting the level control to a value out By side of the allowed range of 0 to 100 the HAL sets the level to the limit value Get label message where lt LA amp n gt n is the control number Send this to HAL to set the label for a Level external con trol to a new value Set label message where lt LA amp n amp string g
80. ts in the program e Compile the user interface and transfer it to your touch panel s Once your application is running you can use the SIMPL debugger in Crestron Toolbox to pinpoint mistakes in your program by watching how signal states change as you interact with your touch panel s Getting Started This section shows how to set up your system so that you can get the most out of the examples The principal com ponents of your system are the Windows PC and Crestron controller Both should reside on the same network so that they can communicate easily Configure their IP settings and plug them into the Ethernet switch using the Eth ernet cables Launch Halogen on the PC so that 1t can pretend to be a HAL A virtual HAL starts running on your PC when you launch Halogen This process goes away when you exit Halogen Make sure to have the right configuration file open in Halogen when testing your system Use the ControlSystemSample hal file that came with the Crestron Support Package when working with the examples 17 ANE CRESTRON CONTROL SYSTEMS GUIDE Halogen amp XPanel Crestron PC Controller 10 0 0 6 10 0 0 8 RO Ethernet Switch Minimal Example Network In addition to substituting for a HAL the PC will also act as a touch panel by using the standalone XPanel desk top application generated by Vision Tools Pro e The XPanel executable should be targeted for Windows PCs Halogen Crestron XPanel PC Controller PC 10 0 0 6 1
81. ts of your system are communicating properly when the Connected status indicator in the upper right corner of the XPanel is blue If the XPanel fails to connect to the controller on startup an error pop up dialog saying Control System Connection Disconnected will eventually appear If this dialog does not come up but the connected status indicator is still blacked out then the controller is not connecting to Halogen Refer to Troubleshooting on page 47 if you find yourself struggling to establish communications Configuring IP Addresses A Crestron controller connects to a HAL or PC running Halogen via TCP IP The easiest way to accomplish this connectivity is by assigning the HAL or PC a static IP address You configure a HAL s static IP addresses from the Host Device Settings dialog in the Hardware workspace To access this dialog connect to your HAL hover your mouse over the HAL bar at the top of the Hardware Map then click on the gear icon that appears The Host Device Settings dialog is only available when Halogen is con nected to a HAL Host Device Settings like static IP assignments reside solely on that HAL and do not travel with the Halogen configuration file 19 JANE CRESTRON CONTROL SYSTEMS GUIDE Internet Protocol Version 4 TCP TPv4 Properties You can get IP settings assigned automatically if your network supports this capability Otherwise you need to ask your network administrator for the appropriate IP settin
82. w to view the example touch panel design Select the Default Level button in the Sound page window Notice that the Digital Press Join number for this button is set to 4 to match the fb4 input and press4 output on the XPanel symbol in the program The touch panel button will appear raised when it is in its inactive state and depressed when it is in its active state 35 CRESTRON CONTROL SYSTEMS GUIDE et KI ee Soe ei as LAET Pr ere ARGNELE Cll zecc rankalicexurmmentzukKace HAL Creiren 3 V File as Drew Layout Display Dpto Took Window Help Weu SW Ga B ier GEOR Pre a Active Face Coie Ji oi er Ui kb BAARAR Cok SONO EAA OE a D Ath SE ae Ra DD SR dh ce K ls k O Abr HEF 3 10 Y D H O o o Fy Br 5 gt ul WTPro e Mp Rane HAL TE E A Synchrenize States Descnptsan Page Flg Type Sappress Key Click Obpect Harme formulation Mode Momentary Template Data Command EJ O EJ 2 Default Level 4 O O O Type select a digital press join from the Et box by dbck mg of click A to automatically assign the D st Svalabie ga ca chopre a reserved jon number Cuno LS 101 Bee Fe Hone dora d Launch the XPanel and verify that the Connected status indicator shows that you are connected Refer to the Trou bleshooting on page 47 section if the status indicator says Disconnected Drag the Lounge slider on the XPanel up to about 90 Now press

HAL Crestron Control Systems Guide

Contents

Download Pdf Manuals

Related Search

Related Contents