You are here: Getting Started > Using the HAL System Documentation

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 is 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:

  • 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 website, checking for updates to the Halogen software, and sending an email to Rane.
  • 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.
  • 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.
  • To search for information within the Help System, you 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 displayed topic: Quick Search Box
HAL System Design Guide

This guide is offered as a PDF file and contains a product overview, details about the HAL System's key features, 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 as well as on the product DVD.

AMX Control Systems Guide

This guide, offered as a PDF file, includes an introduction to using external control systems with HAL. It also discusses an example HAL1 configuration and how to set up an AMX controller and touch panel to communicate 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 operation 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 contents of this support package include:

  • AMXControlSystems_Guide.pdf - The AMX Guide pdf file
  • ControlSystemSample.hal - Halogen configuration file intended for loading in Halogen or your HAL1x
  • Rane_HAL.apw - NetLinx Studio program project file
  • Main.axs - NetLinx program source file
  • 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 Halogen -> Guides. If you want to access the files directly they are available on the product DVD or from the Halogen install directory:

  • C:\Program Files (x86)\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.

Crestron Control Systems Guide

This guide, offered as a PDF file, includes an introduction to using external control systems with HAL. It also discusses an example 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 information on 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.

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:

  • CrestronControlSystems_Guide.pdf - The Crestron Guide pdf file
  • ControlSystemSample.hal - Halogen configuration file intended for loading in Halogen or your HAL1x
  • Rane_HAL.smw - SIMPL Windows program project file
  • Rane_HAL_TP.vtp - VisionTools Pro-e touch panel project file
  • Rane HAL Level Processor.usp - SIMPL+ user module source file
  • 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 Halogen -> Guides. If you want to access the files directly they are available on the product DVD or from the Halogen install directory:

  • C:\Program Files (x86)\Rane Corporation\Halogen\Guides\Support Packages\Crestron directory

You can also download the most up-to-date version of this support package from the Rane website.

Stardraw Control Systems Guide

This guide, offered as a PDF file, includes an introduction to using external control systems with HAL. It also discusses an example HAL1 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 operation 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 Package. The contents of this support package include:

  • StardrawControlSystems_Guide.pdf - The Stardraw Control Guide pdf file
  • ControlSystemSample.hal - Halogen configuration file intended for loading in Halogen or your HAL1x
  • HAL1 Stardraw Example Project.s03 - Stardraw Control Project
  • HAL1 Example Driver.cs - Stardraw HAL1 driver source code. This is part of the Stardraw Control Project but is 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 Halogen -> Guides. If you want to access the files directly they are available on the product DVD or from the Halogen install directory:

  • C:\Program Files (x86)\Rane Corporation\Halogen\Guides\Support Packages\Stardraw Control directory

You can also download the most up-to-date version of this support package from the Rane website.