The AlohaSpy.ini file, stored in the %Iberdir%\ directory on the BOH file server, determines how terminal messages route to the security system. Create and edit this text file to reflect the installed hardware, and the settings established in Aloha Manager. AlohaSpy.ini requires three types of sections, each of which you must repeat as often as necessary to account for all security cameras in use, and the terminals to which they are attached.

COMM# section

The first section refers to the serial port on the Aloha BOH file server, if the security system is that computer through a serial connection. Communication occurs between the FOH terminals and the BOH server, based on the IP address and the TCP port specified in Aloha Manager, with the same TCP port also specified in the AlohsSpyPort environment variable. You will need one section like this in the file to describe the port in use. Match the settings in the COMM section to the settings for the port you are using, as stated in the Windows Device Manager.

Specifies the COM, or serial, port with which the security system is attached on the Aloha BOH file server, as appropriate. In all cases, use the string ‘COMM,’ and provide values, such as baud rate, parity, and stop bits, as stated in the Windows Device Manager.

• [COMM1]
• BAUDRATE=9600
• PARITY=0
• STOPBITS=1

Here:

• BAUDRATE — Specifies the speed at which the video cameras communicate.
• PARITY — Determines if the serial port checks for parity bits, within the video transmission stream.
• STOPBITS — Determines if the serial port requires a terminating, or ‘stop’ bit for each transmission data segment.

DEVICE# section

The second section refers to the security camera, and the type of port to which it connects. You will need one section like this for each security camera. Change the ‘DEVICE#’ string in the header for subsequent sections, if you add more cameras, e.g. ‘[DEVICE2]’ and ‘[DEVICE3].’

Specifies the security camera number. This number is one (1), unless the site uses more than one camera. Each DEVICE heading requires a corresponding TERM heading.

• [DEVICE1]
• DEVICETYPE=COMM
• DEVICETYPEID=1

Here:

• DEVICETYPE — States the type of port to which the video camera is attached on the security system. In most cases, set this value as ‘COMM,’ unless otherwise specified by the security system manufacturer.
• DEVICETYPEID — Determines if the serial port checks for parity bits, within the video transmission stream.

TERM# section

The third section identifies the terminals monitored by Aloha Spy, the type of security system installed at the site, and associates the terminal with the camera monitoring it. The following are example sections showing three terminals, all being monitored by the same camera.

• [TERM1]
• DEVICEID=1
• SPYTYPE=TVS
• [TERM2]
• DEVICEID=1
• SPYTYPE=TVS
• [TERM3]
• DEVICEID=1
• SPYTYPE=TVS

If a separate camera monitors each terminal, then each subsequent section will contain a ‘DEVICEID=’ statement followed by a different number, e.g. ‘DEVICEID=2,’ and ‘DEVICEID=3.’

Specifies the terminal being monitored by the video camera, one section (header) for each terminal, by using the terminal ID number, as in TERM3. Each TERM section includes information about the security system type, and the camera ID number, the DEVICEID.

Here:

• DEVICEID — States the ID number of the security camera attached to the terminal. If there is only one camera, this number is one (1).
• SPYTYPE — Identifies the type of security system installed at the site. AlhaSpy.exe currently supports the value ‘TVS,’ although other strings may work if they are identical in each TERM# section.

Many popular security systems available today use a peripheral device that accepts data directly from the security cameras and text inserters, with a separate data input connection from the Aloha BOH file server. In all cases, refer to documentation provided by the security system manufacturer, as to hardware configuration.

Examples of AlohaSpy.ini files

Two examples of AlohaSpy.ini files appear in this section, to help you see how the example sections work together to define a viable working environment. The intent of these examples is to show how the different types of sections work together. These examples may or may not be applicable to your security system, and how its manufacturer wants the file configured. Contact your security system manufacturer for specific recommendations before you create your own AlohaSpy.ini files.

Example of AlohaSpy.ini file with one camera monitoring three terminals

In this example, one camera is mounted so that three terminals are in plain sight. The text inserters receive input from all three terminals, and superimpose the data on the video image in real-time, and in the recorded image.

• [COMM1]
• BAUDRATE=9600
• PARITY=0
• STOPBITS=1
• [DEVICE1]
• DEVICETYPE=COMM
• DEVICETYPEID=1
• [TERM1]
• DEVICEID=1
• SPYTYPE=ABC
• [TERM2]
• DEVICEID=1
• SPYTYPE=ABC
• [TERM3]
• DEVICEID=1
• SPYTYPE=ABC

Example of AlohaSpy.ini file with two cameras monitoring three terminals

This example illustrates an installation in which one camera monitors terminals #1 and #2, and a second camera monitors terminal #5. Terminals #3 and #4 are not monitored in this example.

• [COMM1]
• BAUDRATE=9600
• PARITY=0
• STOPBITS=1
• [DEVICE1]
• DEVICETYPE=COMM
• DEVICETYPEID=1
• [TERM1]
• DEVICEID=1
• SPYTYPE=ABC
• [TERM2]
• DEVICEID=1
• SPYTYPE=ABC
• [DEVICE2]
• DEVICETYPE=COMM
• DEVICETYPEID=1
• [TERM5]
• DEVICEID=2
• SPYTYPE=ABC

To create or edit the AlohaSpy.ini file:

• Select Start > Program > Windows Explorer.
• Select the \AlohaQS or the \Aloha directory, depending on if you are using Quick Service or Table Service.
• Right-click a blank area in the Aloha directory, and select File > New> Text Document.
• Type AlohaSpy.ini and press Enter.
• Click Yes, if a message appears asking you if you want to rename the file.
• Double-click AlohaSpy.ini to edit the file using Notepad.
• Type the command lines according to the specifications.
• Select File > Save to save the file.
• Select File > Exit to close the file.

Register or stop the AlohaSpy service

After all configuration is complete, and the AlohaSpy.ini is in place, the only task left is to register the AlohaSpy.exe program as a service.

To register AlohaSpy.exe as a service:

• Select Start > Run.
• Type Cmd in the Open text box.
• Use the CD command to change to the \AlohaQS\Bin or \Aloha\Bin directory, depending on if you are using Quick Service or Table Service. For example, use the command CD\BootDrv\Aloha\Bin, if this is the location of your Bin directory.
• Type the following commands at the ...\Bin command prompt:
  • Alohaspy /service
  • Net Start Alohaspy.exe
  • RegSvr32 Aspyps.dll
• Type Exit at the command prompt to close the command window. If you are already using the AlohaSpy service in standard mode and need to restart it in debugging mode, you must use a command prompt routine to accomplish this. Use the procedure above, substituting the following commands to restart the AlohaSpy service in debugging mode:
  • Net stop Alohaspy.exe
  • Alohaspy.exe /unregister
  • Alohaspy.exe /Service /Debug
  • Net Start Alohaspy.exe AlohaSpy.exe outputs debugging information to %Iberdir%\Tmp\Debout.spy, if enabled in Aloha.ini.

Create and populate Debout.spy

When you create AlohaSpy.ini, Aloha creates Debout.spy in the %Iberdir%\Tmp directory. The system logs error messages in this file, such as incorrect port setup, and FOH transactions processed through the security system. To cause the system to begin recording detailed information from the security system, add the following variable to Aloha.ini in the NewData directory:

DEBOUTALOHASPY=TRUE

Select Utilities > View Debugging File, in Aloha Manager, and select the debout file from the list to view its contents.

FOH activities recorded in Debout.spy

As employees interact with FOH terminals, Aloha Spy passes information about these activities to the video security system and records the information in Debout.spy, located in the %Iberdir%\Tmp directory. Although each video security system may make use of different Aloha button functions, each system tends to accomplish the following:

• Receives employee activity information from the Aloha system, based on buttons touched by the employee.
• Outputs employee activity as visual text strings to the video monitor, as an overlay on the video image on the monitor, often at the side or the bottom of the main image.
• Records the video image and the visual text strings together as a single image, to the DVR or another computer, depending on the nature of the system.

Return to the main Aloha Spy page.