Creating and Configuring Single Zone Audio Device

Scenario: You want to configure the Single Zone Audio Device.

 

Reference: For background information, see the reference section.

 

Workflow diagram:

 

 

Prerequisites:

  • Single Zone Audio Device is installed and configured.
  • System Manager is in Engineering mode.
  • System Browser is in Management View.

 

Steps:

1 – Create and Start a Single Zone Audio Driver
  1. Depending on where to add the single zone audio driver, select one of the following:
  • Project > Management System > Servers > Main Server > Drivers
  • Project > Management System > FEPs > [FEP Station] > Drivers
  • Object Configurator tab displays in the Primary pane.
  1. Click New and select New Single Zone Audio Driver.
  1. (Optional) In the New object dialog box, enter a unique description text.
  1. Click OK.
  • The Single Zone Audio driver is added to System Browser.
  1. In the Operation tab navigate to the Driver Status property and click Start.
  • The Single Zone Audio driver is created and started.

 

2 – Configure a Single Zone Audio Driver
  1. Click the added Single Zone Audio driver and click the Driver Editor tab.
  1. Open the Driver Settings expander.
  • A description for the driver displays. It can be edited.
  1. In the Configuration Properties expander, do the following:
  • Enter 20000 in the Device Request Timeout field (default is 10000 milliseconds). The Device Request Timeout is the maximum time required to receive a response after sending a request to the device.
  • Enter 90000 in the Check Status Rate field (default is 30000 milliseconds). The Check Status Rate is the duration after which, the driver checks status of all the devices controlled by this driver.
  1. In the Notification Integration expander, do the following:
  • Select Enable Notification Integration check box.
  • In the Batch Size field, set the value as 10 (default is 100). Batch size specifies the size in which the request is processed by the driver. The batch size displays the number of devices to which Notification interacts in one instant. For example, if there are 100 devices on which a message has to be displayed and a batch size of 10 is entered, Notification will send the message to batches of 10 devices each.
    NOTE: The batch size must be equal to or greater than the total number of the configured single-zone recipient devices.
  1. In the Expected delivery time field, enter the time in seconds. The default expected delivery time is 5 seconds.
    NOTE: Notification does not guarantee that the message delivery will be completed within the time entered in the Expected delivery Time field. This value is solely used to compute delivery statistics indicating whether message delivery to the Single Zone Audio device was on-time or late.
  1. Click Save .
  • The parameters are configured for the Single Zone Audio driver.

 

3 – Create Single Zone Audio Field Network
  1. Select Project > Field Networks.
  • The Object Configurator tab displays in the Primary pane.
  1. Click New Object and select New Single Zone Audio Field Network.
  • The Create New Object dialog box displays with the Child type field pre-defined as Single Zone Audio Field Network.
  1. Enter a name and description.
  1. Click OK.
  • The Single Zone Audio Field Network node appears under the Field Networks Hierarchy node.
  • The Single Zone Audio driver is automatically associated to the field network. In the Network Editor tab, under the Network Settings expander, you can see that the values are preselected, and the driver is already assigned.

 

4 – Create Single Audio Zone Device
  1. Select Project > Field Networks > Single Zone Audio Field Network.
  1. In the Network Editor tab, click Create .
  1. In the New object dialog box, enter a name and description.
  1. Click OK.
  1. In the Device Settings expander, enter a description for the device.
  1. Open the Configuration Properties expander.
  1. In IP Address field, enter the IP address of the Perle device, if Perle device is used to activate Single Audio Zone. In case of a Single Audio Zone without a Perle device, enter value as -1.
  1. In the Serial Port Number field, enter the number of Serial COM port created by TruePort for a particular Perle device.
  1. From the Device Mode drop-down list, select Operational.
    NOTE:     The following options available in the Device Mode drop-down list:
    a) Disabled: In this mode, the driver does not process the messaging command and/or the device configuration change command, but will perform status checks for the device. The device remains in a Disconnected state.
    b) Operational: In this mode, the driver processes the messaging command, the device configuration change command, and performs status checks for the device. The device will be in a Disconnected or Connected state.
    c) Administrative: In this mode, the driver processes the device configuration change command and performs status checks for the device. The device will be in a Disconnected or Connected state.
  1. Set the Extension Number field to the extension of the Line Level Audio device connected to the fire panel.
    NOTE: For details on creating extensions for the Line Level Audio device, refer to the Configuring Telephony Device section.
  1. Set the Relay Number field to the relay used for this particular audio interface.
    NOTE 1: There is no need to set the relay number when the serial port number is set to -1. For others, it can be set to either 1 or 2. To use a Single Audio Zone with a Perle device, set the Serial Port Number field to the COM port that was configured for IO access for the Perle device (for example, COM100). To use a Single Audio Zone without a Perle device, set the Serial Port Number to -1.
    NOTE 2: For DTMF devices, a Single Audio Zone is used without a Perle device. Set the Serial Port Number to -1, if using a DTMF device.
    NOTE 3: To check the COM ports that were used by the device, open the TruePort Management Tool.
  1. In the Relay Activation Time field, enter the relay activation time.
    (for example, [0:15000]”- 15 seconds (15000) is the maximum allowed delay).
  1. If using a DTMF device, set the DTMF activation sequence in the DTMF Activation Sequence field. For more information, refer to 6 – Generating DTMF Sequences.
  1. If using a DTMF device, set the DTMF deactivation sequence in the DTMF Deactivation Sequence field.
  1. Click Save .

 

5 – Verify Devices and Driver

To verify that the Single Zone device is configured correctly, view the connection status of the device under the field network. Additionally, use the Telephony Configuration tool to verify that the audio device has properly registered with the Telephony Server. To verify the extension status in the Telephony Server, refer to the Telephony Device section.

Perle Device

SIP Extension

Device Status on UI

Valid Com Port and Connected

Within the configured Extension range of FreeSwitch and Connected

Connected

Valid Com Port and Connected

Within the configured Extension range of FreeSwitch and Disconnected

Disconnected

Valid Com Port and Connected

Not in the configured Extension range of FreeSwitch

Unknown

Com Port value is -1

Within the configured Extension range of FreeSwitch and Connected

Connected

Com Port value is -1

Within the configured Extension range of FreeSwitch and Disconnected

Disconnected

Com Port value is -1

Not in the configured Extension range of FreeSwitch

Unknown

Valid Com Port and Disconnected

Within the configured Extension range of FreeSwitch and Connected

Disconnected

Valid Com Port and Disconnected

Within the configured Extension range of FreeSwitch and Disconnected

Disconnected

Valid Com Port and Disconnected

Not in the configured Extension range of FreeSwitch

Disconnected

6 – Generating DTMF Sequences

Dual Tone Multiple Frequency (DTMF) is essentially used to depict the 4X4 Matrix keypad used for a standard telephone keypad. Valid characters for DTMF sequences are digits "0-9", "A-D", "*", "#",comma (,), and "p". The digits, letters, pound, and asterisk map to the DTMF tones as defined by ITU-T Recommendation Q.23. The comma (,) and "p" both represent 500 ms pauses in the play sequences. Multiple "," and "p" can be written in sequence to achieve longer delays.

The system will ignore any characters in configured DTMF sequences that are not valid DTMF characters. DTMF constitutes two frequencies (high frequency and low frequency) which are combined together for denoting a DTMF digit.

NOTE: The pauses feature ","and "p" is meant for user-defined pauses, for example, to control interactive voice response (IVR) systems, and does not represent the silent gaps between the DTMF tones. The system automatically inserts these gaps between DTMF tones.

The following table depicts a 4X4 matrix keypad.

 

1209 Hz

1336 Hz

1477 Hz

1633 Hz

697 Hz

1

2

3

A

770 Hz

4

5

6

B

852 Hz

7

8

9

C

941 Hz

*

0

#

D

For example, in the activation or deactivation sequence, if using the 4 key, it generates two frequencies, 1209 Hz and 770 Hz. The tones and speech easily mix with one another and the tone detection hardware can separate the DTMF out for applications that require it. After detecting the tone, the tone detection hardware decides whether to activate or deactivate the DTMF enabled devices.

Some examples of the activation and deactivation sequences for DTMF devices are listed in the following table.

DTMF Device

Auxiliary Output 1

Auxiliary Output 2

Auxiliary Output 3

 

Activate

Deactivate

Activate

Deactivate

Activate

Deactivate

Talk-A-Phone VOIP500K

*4***11*

*4***21*

*4***12*

*4***22*

*4***13*

*4***23*

Code Blue IP5000

4

4

5

5