Download as pdf or txt
Download as pdf or txt
You are on page 1of 40

VIPEDIA-NET Network Card

VIPEDIA-12 / INTEGRA Contact Inputs

Configuration Guide

ASL Document Ref: U-0582-4644.docx


Issue: 01 Complete, Approved - Date: 12/12/19
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

Contents
1 Introduction ........................................................................................................................................................ 3
2 Configuration ...................................................................................................................................................... 4
2.1 Configuration Using the PAVA SCT ............................................................................................................... 4
2.1.1 On-Board Contact Input ........................................................................................................................... 4
2.1.2 BMB01 Device ......................................................................................................................................... 5
2.2 Configuration using the VCT .......................................................................................................................... 6
2.2.1 Run Announce-d ...................................................................................................................................... 6
2.2.2 VIPEDIA-NET Contact Input .................................................................................................................... 8
2.2.3 Run Announce-d on Another VIPA Device for Reduced Routing Delays ............................................... 19
2.2.3.1 Primary Alternative VIPA Device for DVA Routing .............................................................................. 19
2.2.3.2 Secondary Alternative VIPA Device for DVA Routing ......................................................................... 21
2.2.4 DVA Streaming For DVA Synchronisation ............................................................................................. 24
2.2.5 Volume Control ...................................................................................................................................... 28
APPENDIX A – VIPA Config Tool View Settings............................................................................................................... 29
APPENDIX B – Audio Device Configuration for DVA Playback ........................................................................................ 30
APPENDIX C – “pmcx” Audio Group Configuration .......................................................................................................... 32
APPENDIX D – Global “vipa” Configuration File ............................................................................................................... 33

Copyright © 2019 Application Solutions (Safety and Security) Limited

Application Solutions (Safety and Security) Limited


Unit 17 Cliffe Industrial Estate
Lewes - East Sussex
BN8 6JL - UK
Tel: +44(0)1273 405411 Fax: +44(0)1273 405415
www.asl-control.co.uk

All rights reserved.

Information contained in this document is believed to be accurate, however no representation or warranty is given and Application
Solutions (Safety and Security) Limited assumes no liability with respect to the accuracy of such information.
U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19
Page 2 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

1 Introduction
This Configuration Guide describes how to configure VIPEDIA-12 / INTEGRA contact inputs to trigger DVA
messages that are stored on VIPA devices such as VIPA Host (Lanner or Linutop), VIPEDIA-NET Network
Card, iPAM400 and VIPA Server.

This feature requires VIPA V3.1.x or Network Card V3.1.x.x onwards and PAVA System Configuration Tool
V3.1.x onwards.

The configuration is done via the PAVA System Configuration Tool and the VIPA Config Tool.

DVA routing can be performed by another VIPA device to prevent routing delay issues. In which case multiple
VIPA devices can be configured as a backup.

DVA streaming can be configured to prevent synchronisation issues.

This document is correct for the following firmware and software versions. Older or newer versions
may behave differently.
• VIPA Stack V3.3.3
• VIPEDIA-NET NET-VIPA V3.3.3.68L
• VIPA Config Tool V3.3.3.0082
• VIPEDIA-12 / INTEGRA V3.3.3.0L
• PAVA System Configuration Tool V3.3.3.1L

This document assumes the user has existing knowledge and experience of VIPEDIA-12 /
INTEGRA configuration procedures using the PAVA System Configuration Tool and VIPA and
Network Card configuration procedures using the VIPA Config Tool.

This document only covers Vipedia contact inputs (BMB01 or on-board) routing VIPA DVAs.

This document uses the following terminology:


• “PAVA SCT” refers to the PAVA System Configuration Tool.
• “VCT” refers to the VIPA Config Tool.
• “VIPA devices” refers to VIPA Host (such as Linutop or Lanner), VIPEDIA-NET Network
Card, iPAM400, VIPA Server, etc. Specific devices will be referenced where required.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 3 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

2 Configuration
Configuration should be performed in the following sequence. Refer to each section for the configuration
procedures.
1. Contact input configuration on VIPEDIA-12 / INTEGRA using the PAVA SCT (section 2.1 below).
2. Network Card and VIPA device configuration using the VIPA Config Tool:
a. Standard announce-d settings (section 2.2.1 on page 6).
b. The Network Card contact input configuration (section 2.2.2 on page 8).
c. Run announce-d on another VIPA device to avoid routing delays (if required) (section 2.2.3
on page 19).
d. The DVA streaming setting to avoid synchronisation issues (if required) (section 9 on page
23).
e. The volume control setting (if required) (section 2.2.5 on page 28).
3. After the configuration is complete, upload the PAVA SCT configuration and the VCT configuration to
the system.

2.1 Configuration Using the PAVA SCT


2.1.1 On-Board Contact Input
1. Open the PAVA SCT configuration and expand the system tree. Navigate to the VIPEDIA-12 /
INTEGRA that the contact is wired onto.
2. Expand the “GPIO” item and click On Board.
3. Select the “Inputs” tab.
4. Select the drop-down list on the input that the contact is connected to.
5. Select VIPA Input [Volt Free] (analogue input) or VIPA Input [Volt Driven] (digital input), as
required.

Figure 1 - PAVA SCT VIPA input on an on-board contact

6. Configure the Monitored setting as required (if available).

For information on [Volt Free], [Volt Driven], and the monitored setting, refer to the PAVA System
Configuration Tool User’s Manual (U-0701-1583).
7. Configure the Active Low / Active High setting as required.

Active Low and Active High determines the activation state of the trigger:
• Active Low: triggers when the contact is closed.
• Active High: triggers when the contact is opened.
VIPA devices have a corresponding setting in the VCT “Select Value (Logical Level)”. For more
information, refer to Table 1 on page 12.

8. Enter a Description as required.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 4 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

2.1.2 BMB01 Device

1. Open the PAVA SCT configuration and expand the system tree. Navigate to the VIPEDIA-12 /
INTEGRA GPIO configuration section.
2. Expand the “GPIO” item.
3. Select the BMB01 that matches the ID number of the BMB01 that the contact is wired onto.
4. If there is currently no BMB01 present:
a. Right click on the “GPIO” item.
b. Select “Add” and click “Add BMB”.
c. In the Device Address setting, select the ID number of the BMB01 from the drop-down list.
5. Select the “Volt-Free Contacts” (analogue inputs) or “Volt-Driven Contacts” (digital inputs) tab as
required.
6. Select the drop-down list of the input that the contact is connected to.
7. Select VIPA Input.
8. Click on the “Options” button.

Figure 2 - PAVA SCT VIPA input on a BMB contact

9. Configure the Monitored setting as required (only available on analogue inputs).

For information on the monitored setting, refer to the PAVA System Configuration Tool User’s
Manual (U-0701-1583).

10. Configure the Active Low / Active High setting as required.

Active Low and Active High determines the activation state of the trigger:
• Active Low: triggers when the contact is closed.
• Active High: triggers when the contact is opened.
VIPA devices have a corresponding setting in the VCT “Select Value (Logical Level)”. For more
information, refer to Table 1 on page 12.

11. Enter a Description as required.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 5 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

2.2 Configuration using the VCT


2.2.1 Run Announce-d

The VIPA host device “Run Announce-d” setting is configured according to the intended destination of DVA
routes.
Configuration Procedure:
1. On the VCT, go to the VIPA device “Standard Settings” tab.
2. Configure the Run announce-d setting as required:
a. Global – Select this setting if this VIPA device is to route DVA messages or other audio
sources to outputs on one or more other devices in the VCT configuration.
b. Local – Select this setting if this VIPA device is to route DVA messages or other audio
sources only to outputs on the device itself.
c. No – Select this setting if this VIPA device is not to route to any zones.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 6 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

3. If the Run announce-d setting is set to Global, go to the “Advanced Settings” tab of the VIPA
device and configure the Host Whitelist for Announcements setting as required.
This setting is used to reduce the number of destinations which reduces the number of messages
processed by announce-d. This can help if routing delay issues are present.
4. Enter the destination VIPA hostnames as required, separated by commas.
• If blank, all hosts are available.
• If not blank, hosts that are not included in the list are not available.
By default, it is blank.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 7 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

2.2.2 VIPEDIA-NET Contact Input

1. Right-click on the VIPEDIA-NET that is connected to the VIPEDIA-12 / INTEGRA that the contact is
wired to.
2. Select Add, then click on BMB.
There are two options for BMB. The first option adds a BMB with no inputs or outputs. The second
option adds a BMB with all 24 inputs and 12 outputs added and ID’s automatically assigned in
sequential order.
3. Click on the desired option to add the BMB.
This document assumes the Show Quick Add Options Only setting in the view menu is
disabled. See APPENDIX A - VIPA Config Tool View Settings on page 29 for more details.

Adds a BMB with no inputs or


outputs.

Adds a BMB populated with all


inputs and outputs.
(Note - this is the only option
available when “Show Quick Add
Options Only” is enabled.)

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 8 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

4. Set the BMB ID:


• If the contacts are BMB01 contacts, set the ID to match the corresponding BMB01 device in
the PAVA SCT.
• If the contacts are VIPEDIA-12 / INTEGRA on-board contacts, set ID = 0.

5. The Serial Port field is not required but must be defined. Enter any text.

On-board GPIO: ID = 0 Enter


BMB01: ID = 1 to 9 any text

6. Select or add the first analogue or digital input.


To add an input, right click on the BMB in the navigation window, select Add, then select Analogue
Input or Digital Input, as required.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 9 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

7. Name the input.


8. Set the Channel number – This is the BMB or on-board contact input ID on the PAVA SCT (VIPA
Input).
9. Set the Mode to Contact Driven Input.

The analogue input Operational Range


settings in Optional Settings are not
used.

10. Right-click the VIPEDIA-NET in the navigation window, select Add then click Contact Driven Input.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 10 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

11. Under “Required Settings” set the Audio Group to mic1.

12. Set each of the attributes in the “Optional Settings” tab as required. Each attribute for the Contact
Driven Input is explained on Table 1 on page 12.

Optional Settings

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 11 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

Table 1 – Contact Driven Input optional attributes


Attribute Default Settings Description

Auto Announce Disabled Not applicable to DVA messages.

Select Timeout Not configured Not applicable to DVA messages.

Response 3000 ms The period of time to wait for a response from the announcement
Timeout process.

If there are problems when overriding and restoring announcements this


setting should be increased to 10000 ms.

Chime File <Blank> The chime file that is played by the VIPA device before each
announcement.
• Chime 1 – Plays a single-note chime.
• Chime 2 – Plays a two-note descending overlapping chime.
• Chime 3 – Plays a three-note descending overlapping chime.
• <Blank> – No chime is played.
Priority 10 Defines the priority for announcements triggered by all contact inputs
controlled by this Contact Driven Input.

Note this can be individually configured for each contact if required.

Range: 0 to 63.

Permissions: Selected If selected, the volume of announcements triggered by all contact inputs
on this Contact Driven Input will be subject to ANS (Ambient Noise
ANS enabled Sensor) compensation.

Note this can be individually configured for each contact if required.

Permissions: Selected If selected, announcements triggered by all contact inputs controlled by


this Contact Driven Input will proceed even if not all of the selected zones
Allow partial grant are available.

Note this can be individually configured for each contact if required.

Permissions: Not selected If selected, overridden announcements triggered by all contact inputs
controlled by this Contact Driven Input are restored after override is
Allow partial loss removed.

Note this can be individually configured for each contact if required.

Permissions: Not selected If selected, announcements triggered by all contact inputs controlled by
this Contact Driven Input are limited by the Night Volume Control (NVC)
Do not apply NVC function of the PAVA system.

Note this can be individually configured for each contact if required.

Permissions: Not selected If selected, announcements triggered by all contact inputs on this Contact
Driven Input will not stop the ANS calculation throughout the
Do not freeze announcement.
ANS
Note this can be individually configured for each contact if required.

Permissions: Not selected If selected, announcements triggered by all contact inputs on this Contact
Driven Input will use priority-based routing and will override routes that
Do not queue are lower priority.
If not selected, the announcement will not override routes, even if higher
priority. Instead it will be queued until all target zones are free. If DVA, the
amount of time the announcement is queued is defined on the
announce-d DVA Timeout setting on the VIPA device's “Advanced
Settings” tab.
Note this can be individually configured for each contact if required.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 12 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

Attribute Default Settings Description

Permissions: Not selected Not applicable to DVA messages.

Do not timeout

Permissions: Not selected If selected, announcements triggered by all contact inputs on this Contact
Driven Input are of (high) emergency class and will activate the VA (Voice
Emergency class Alarm) indication in the PAVA system.
route
Note this can be individually configured for each contact if required.

Permissions: Not selected If selected, announcements triggered by all contact inputs on this Contact
Driven Input will not light the busy LEDs on microphones.
Non busy route
Note this can be individually configured for each contact if required.

13. Set each of the attributes in “Advanced Optional Settings” as required. Each attribute for the Contact
Driven Input is explained on Table 2 below.

Advanced Optional Settings

The “Enable Advanced Optional Settings” VCT view setting must be enabled for this tab to be
editable. See APPENDIX A – VIPA Config Tool View Settings on page 29 for guidance.

Table 2 - Contact Driven Input advanced optional attributes


Attribute Default Settings Description

announce-d Ref announce-d/Jcop The internal process that will handle the DVA announcements.

By default, the setting applies to the Network Card hosting the Contact
Driven Input is controlled by.

io-bmb-d Ref io-bmb-d/Jcop Not configurable.

var-gateway-d Ref rtr_jcop/Jcop This setting should be left as default.

Default Busy 1 Not applicable to VIPEDIA-12 / INTEGRA contacts.


(Logical Level)

Default Select 1 Ensure this is set to 1.


(Logical Level)

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 13 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

14. If required, delete any Analogue Input, Digital Input, and Digital Outputs that are not used.
15. Right-click the Contact Driven Input in the navigation window, select Add then click Contact.

16. Configure the Type as required:

• DVA – Routes a DVA message to pre-configured zones.


• BMB Triggered DVA Reset – Cancels selected DVA messages triggered by a latching input.
• BMB Triggered DVA Global Reset – Cancels all DVA messages triggered by a latching input
on the same Contact Driven Input.
• BMB Triggered DVA Global Silence – (Not covered in this document).
• PTT – (Not covered in this document).
• Zone Select – (Not covered in this document).

The options related to DVA routing are: DVA, BMB Triggered DVA Reset, and BMB Triggered
DVA Global Reset.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 14 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

17. Set the attributes in the “Required Settings” tab as required. The available attributes will depend on
the selected contact type.

Required Settings

DVA contact:
Table 3 - DVA contact required settings
Attribute Default Settings Description
Select Not configured The BMB analogue or digital input that triggers this DVA.

Zones Not configured The zone(s) the DVA announcement triggered by this contact will play to.

File Name Not configured This setting depends on the location of stored DVA messages on the
VIPA device:

• If stored in folder /dva/msgs/ - Enter the name and file type of the
DVA file.
For example: “test.wav”.
• If stored in another location – Enter the complete path to the DVA
file.

For example: “/dva/msgs/dist/other/test01.wav”.

Latching Disabled If enabled, the DVA will not stop when this contact input is deactivated. A
DVA Reset is required to stop the DVA route.

Play Count 1 The number of times the DVA message is played.


Range: 1 to 1000, or forever.

Delay 0 ms The delay between the trigger and the first play of the DVA (in
milliseconds).

Range: 0 to 3000 ms.

Gap 0 ms The gap between DVA message repeats (in milliseconds).

Range: 0 to 60000 ms.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 15 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

DVA Reset contact


Table 4 - BMB Triggered DVA Reset contact required settings
Attribute Default Settings Description
Select Not configured The BMB analogue or digital input that resets the selected DVAs.

Inputs To Reset Not configured The DVA contact inputs this contact will reset when activated.

DVA Global Reset contact


Table 5 - BMB Triggered DVA Global Reset contact required settings
Attribute Default Settings Description
Select Not configured The BMB analogue or digital input that resets all DVAs on this Contact
Driven Input.

18. Set the attributes in the “Advanced Optional Settings” tab as required. The available attributes will
depend on the selected contact type.

Advanced Optional Settings

The “Enable Advanced Optional Settings” VCT view setting must be enabled for this tab to be
editable. See APPENDIX A – VIPA Config Tool View Settings on page 29 for guidance.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 16 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

DVA contact
Table 6 - DVA contact advanced optional settings
Attribute Default Settings Description
Select Value 1 Ensure this is set to 1.
(Logical Level)

Priority Matches Contact Defines the priority of the DVA message this contact triggers.
Driven Input setting
To use a different setting to the Contact Driven Input setting, check the
“Override” checkbox.

Permissions: Matches Contact If selected, the volume of DVA announcements triggered by this contact
Driven Input setting will be subject to ANS (Ambient Noise Sensor) compensation.
ANS enabled
To use a different setting to the Contact Driven Input setting, check the
“Override” checkbox. This will allow each permission to be selected
manually.

Permissions: Matches Contact If selected, DVA announcements triggered by this contact will proceed
Driven Input setting even if not all of the selected zones are available.
Allow partial grant
To use a different setting to the Contact Driven Input setting, check the
“Override” checkbox. This will allow each permission to be selected
manually.

Permissions: Matches Contact If selected, overridden DVA announcements triggered by this contact are
Driven Input setting restored after override is removed.
Allow partial loss
To use a different setting to the Contact Driven Input setting, check the
“Override” checkbox. This will allow each permission to be selected
manually.

Permissions: Matches Contact If selected, DVA announcements triggered by this contact are limited by
Driven Input setting the Night Volume Control (NVC) function of the PAVA system.
Do not apply NVC
To use a different setting to the Contact Driven Input setting, check the
“Override” checkbox. This will allow each permission to be selected
manually.

Permissions: Matches Contact If selected, DVA announcements triggered by this contact will not stop the
Driven Input setting ANS calculation throughout the announcement.
Do not freeze
ANS To use a different setting to the Contact Driven Input setting, check the
“Override” checkbox. This will allow each permission to be selected
manually.

Permissions: Matches Contact If selected, DVA announcements triggered by this contact will use priority-
Driven Input setting based routing and will override routes that are lower priority.
Do not queue
If not selected, the DVA will not override routes, even if higher priority.
Instead it will be queued until all target zones are free. The amount of
time the DVA is queued is defined in the announce-d DVA Timeout on
the VIPA device's Advanced Settings tab.
To use a different setting to the Contact Driven Input setting, check the
“Override” checkbox. This will allow each permission to be selected
manually.

Permissions: Matches Contact Not applicable to DVA messages.


Driven Input setting
Do not timeout

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 17 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

Attribute Default Settings Description


Permissions: Matches Contact If selected, DVA announcements triggered by this contact are of (high)
Driven Input setting emergency class and will activate the VA (Voice Alarm) indication in the
Emergency class PAVA system.
route
To use a different setting to the Contact Driven Input setting, check the
“Override” checkbox. This will allow each permission to be selected
manually.

Permissions: Matches Contact If selected, DVA announcements triggered by this contact will not light
Driven Input setting microphone zone select button busy LEDs.
Non busy route
To use a different setting to the Contact Driven Input setting, check the
“Override” checkbox. This will allow each permission to be selected
manually.

Interrupt Disabled This setting should be left as default.

DVA Reset contact


Table 7 - DVA Reset contact advanced optional settings
Attribute Default Settings Description
Select Value 1 Ensure this is set to 1.
(Logical Level)

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 18 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

2.2.3 Run Announce-d on Another VIPA Device for Reduced Routing Delays

The “Host Whitelist for Announcements” setting described in section 2.2.1 Run Announce-d on
page 6 may also prevent routing delays.
On systems where the “Host Whitelist for Announcements” setting is not applicable or does not improve the
routing delay enough, to prevent routing delays it may be required to configure an alternative VIPA device to
handle the DVA routes instead of the Network Card hosting the contacts.
Optionally, a secondary VIPA device can also be configured to route the DVAs in case the primary
alternative VIPA device fails.
This is achieved by configuring the Network Card “announce-d Ref” setting to different VIPA device(s).

2.2.3.1 Primary Alternative VIPA Device for DVA Routing

1. Navigate to the Network Card hosting the contact.


2. Select the Contact Driven Input “Advanced Optional Settings” tab.
3. Set the announce-d Ref to “announced-d@###/Jcop” where “###” is the VIPA device hostname
(e.g. vipa-01).

The “Enable Advanced Optional Settings” VCT view setting must be enabled for this tab to be
editable. See APPENDIX A – VIPA Config Tool View Settings on page 29 for guidance.
4. Navigate to the VIPA device and select the “Standard Settings” tab.
5. Set “Run announce-d” to Global.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 19 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

5. If required, configure Host Whitelist for Announcements.


This setting is used to reduce the number of destinations which reduces the number of messages
processed by announce-d. This can further help if routing delay issues are present.
a. Go to the “Advanced Settings” tab of the VIPA device.
b. In Host Whitelist for Announcements enter the destination VIPA hostnames as required,
separated by commas.
• If blank, all hosts are available.
• If not blank, hosts that are not included in the list are not available.
All target hostnames configured for contact routing on the Network Card should be
included.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 20 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

2.2.3.2 Secondary Alternative VIPA Device for DVA Routing

1. Navigate to the Network Card hosting the contact.


2. Right-click on the Contact Driven Input.
3. Select Duplicate.

4. Select the “Advanced Optional Settings” tab of this duplicated Contact Driven Input.
5. Change the announce-d Ref to the hostname of the secondary VIPA host (e.g. vipa-02).

The “Enable Advanced Optional Settings” VCT view setting must be enabled for this tab to be
editable. See APPENDIX A – VIPA Config Tool View Settings on page 29 for guidance.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 21 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

6. Select the “Optional Settings” tab.


7. Set the priority to lower than the Contact Driven Input on the primary VIPA device (e.g. change from
10 to 11).

8. For each contact that is set with “Override” enabled for priority, decrease the priority to lower than
the matching contact on the Contact Driven Input on the primary VIPA device (e.g. change from 10
to 11).

The adjustment to priority ensures that in normal operation the contacts set to the primary VIPA
device will take priority, not the duplicated contacts set to the secondary VIPA device.

Duplicated items do not have any changes automatically applied to both configurations. The user
must change the Contact Driven Input or Contact configurations on both VIPA hosts if any
changes are made to either.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 22 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

9. Navigate to the VIPA device and select the “Standard Settings” tab.
10. Set “Run announce-d” to Global.

11. If required, configure Host Whitelist for Announcements.


This setting is used to reduce the number of destinations which reduces the number of messages
processed by announce-d. This can further help if routing delay issues are present.
a. Go to the “Advanced Settings” tab of the VIPA device.
b. In Host Whitelist for Announcements enter the destination VIPA hostnames as required,
separated by commas.
• If blank, all hosts are available.
• If not blank, hosts that are not included in the list are not available.
All target hostnames configured for contact routing on the Network Card should be
included.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 23 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

2.2.4 DVA Streaming For DVA Synchronisation

The device that is in control of the DVA routing can be set to stream the DVA messages over the network to
prevent synchronisation issues.

This setting will apply to all DVAs routed from this VIPA device.

Configuration Procedure:

1. Navigate to the VIPA device that is in control of the DVA routing.


By default, this is the Network Card that hosts the Contact Driven Input configuration.
If other VIPA device(s) are configured to route the DVAs instead of Network Card, these are the
device(s) where the DVA streaming is configured.
(As described in section 2.2.3 Run Announce-d on Another VIPA Device for Reduced Routing
Delays on page 19).
2. Select the “Advanced Settings” tab.
3. Enable the Force DVA Streaming setting.

On VCT versions earlier than V3.3.3.0082, Force DVA Streaming and Allow Volume Adjustment
on Routes were configured using a manually created file named “vipa”.
On VCT version V3.3.3.0082 or later, changes to these settings on the VCT will override settings in
the “vipa” file, if used.
If a system configured using the “vipa” file is upgraded using a VCT version V3.3.3.0082 or later,
refer to APPENDIX D – Global “vipa” Configuration File on page 33, or contact ASL.
U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19
Page 24 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

4. Ensure a PMC device that is associated with “pmc” audio groups is configured as described below.
5. If not configured, add a PMC Device.

6. Set the PMC device Port and Multicast Address as required.


Configure multicast settings that do not conflict with any other multicast settings on any part of the
system in the network.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 25 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

7. Add and configure the required number of PMC outputs as described below.
The number of PMC outputs associated with a “pmc” audio group defines the number of audio
sources that can be streamed by this device at the same time.
Note that DVA streaming requires additional settings as described in step 8.
a. Right-click on the PMC Device and add a PMC Output.

b. Select the “Advanced Optional Settings” tab.


Each PMC Output requires a “pmcx” audio group (where “x” is the PMC channel number).
Ensure a “pmcx” audio group is selected.
Note that by default, four “pmcx” audio groups are available (pmc1, pmc2, pmc3 and pmc4).
If required, add more “pmcx” audio groups as described in APPENDIX C – “pmcx” Audio
Group Configuration on page 32.

The “Enable Advanced Optional Settings” VCT view setting must be enabled for this tab to be
editable. See APPENDIX A – VIPA Config Tool View Settings on page 29 for guidance.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 26 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

c. Select the “Required Settings” tab of the PMC Output. Ensure that the Type is set to
Dynamic.

8. Select the “Optional Settings” tab of the PMC Device.


a. Set DVA Starting Channel to match the first PMC channel used for DVA streaming (i.e. the
“pmc” number used in step 7.b. In this example it is “1” for pmc1).
In systems where the device can stream analogue audio sources (e.g. iPAM400), it is possible
to reserve the lower PMC channels exclusively for streaming these analogue audio sources. If
this is the case, set DVA Starting Channel to a higher number.
b. Set DVA Ending Channel to match the last PMC channel used for DVA streaming.
(For example, if the last is pmc7, set DVA Ending Channel to “7”).
The DVA Starting Channel and the DVA Ending Channel defines the total number of DVA messages
that can be streamed by this device at the same time.
In this example, 7 x DVA messages can be streamed at the same time.

This step is not required on Network Cards version V3.3.3.68L onwards.

9. For all VIPA devices (except for Network Card) that stream DVAs, an audio device should be
present in the configuration. This is to avoid audio artefacts on DVA playback. If not present,
configure as described in APPENDIX B – Audio Device Configuration for DVA Playback on page
30.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 27 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

2.2.5 Volume Control

The volume control setting is set on the VIPA device(s) that route the DVA messages.

The volume control setting applies to all types of announcements from this VIPA device.

Configuration Procedure:
1. Navigate to the VIPA device routing the DVA messages.
By default, this is the Network Card that hosts the Contact Driven Input configuration.
If other VIPA device(s) are configured to route the DVAs instead of Network Card, these are the
device(s) that volume control is configured.
(As described in section 2.2.3 Run Announce-d on Another VIPA Device for Reduced Routing
Delays on page 19).

2. Select the “Advanced Settings” tab.


3. Configure Allow Volume Adjustment on Routes as required.
• If Enabled: the volume of all routes from this VIPA device is controlled by Volume Control
devices in the PAVA system.
• If Disabled: the volume of all routes from this VIPA device is not controlled by Volume Control
devices in the PAVA system.

On VCT versions earlier than V3.3.3.0082, Force DVA Streaming and Allow Volume Adjustment
on Routes were configured using a manually created file named “vipa”.
On VCT version V3.3.3.0082 or later, changes to these settings on the VCT will override settings in
the “vipa” file, if used.
If a system configured using the “vipa” file is upgraded using a VCT version V3.3.3.0082 or later,
refer to APPENDIX D – Global “vipa” Configuration File on page 33, or contact ASL.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 28 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

APPENDIX A – VIPA Config Tool View Settings


The VIPA Config Tool (VCT) provides the following view settings to assist the configuration.

• Enable Show Attributes – If enabled, shows the device attributes in the navigation window.

• Enable Advanced Optional Settings – This enables or disables the “Advanced Settings” tab(s).

• Enable Live Settings – This enables or disables the “Live Settings” tab(s).

• Show Quick Add Options Only – If selected, only shows pre-configured components when adding
some items to the configuration.

This document assumes Enable Advanced Optional Settings has been enabled.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 29 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

APPENDIX B – Audio Device Configuration for DVA Playback


For all VIPA devices except for Network Card, an audio device should be present in the configuration to
avoid audio artefacts on DVA message playback.

Configuration Procedure
1. On the VCT, navigate to the VIPA device.
2. If an Audio Device is not present, right-click and add an Audio Device.

3. In the “Required settings” tab select the Sound Card drop down list and choose Onboard Sound.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 30 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

4. If an Audio Input is not present, right-click the Audio Device item and add an Audio Input.

5. Ensure the Audio Input is enabled.

6. Select the “Advanced Optional Settings” tab and select Audio Groups as required.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 31 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

APPENDIX C – “pmcx” Audio Group Configuration


To add more “pmcx” audio groups (where “x” is the channel number):
a. Right-click on the toolbar and ensure Zones And Groups is selected.

b. Right-click on the Audio Groups in the “Zones And Groups” window.


c. Click Add.
d. Name the Audio Group as the next sequential pmc number. In this example, this is pmc5.
The Audio Group name must be correct:
• “pmc” in lower case.
• No spaces.
• Number in sequential order with no leading zero (i.e. “1” not “01”).

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 32 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

APPENDIX D – Global “vipa” Configuration File

VCT and “vipa” Configuration File Compatibility

In versions of the VIPA Config Tool older than V3.3.3.0082 the following settings were not available and
were configured manually by creating a new configuration file named “vipa” in the VIPA device filesystem.
• Volume control
• DVA streaming
• Do Not Queue DVA
These settings are now available on VCT versions V3.3.3.0082 or later.

If any of the following settings are changed from default on the VCT, the “vipa” file settings will be
overridden.
• Volume control
• DVA streaming
Note that these settings are grouped together into the same line in the file. If one setting is
changed, all settings in the line will be overridden by the VCT.
The “vipa” file “ANNOUNCED_EXTRA_OPTIONS” line is:
• DVA streaming over network.
• PAVA system volume adjustment of all types of VIPA routes.
• Do Not Queue DVA.
If the “do not queue” setting in the “vipa” file is overridden due to VCT configuration of DVA
streaming or volume adjustment, the user should ensure the “do not queue” permission setting for
all DVA routes on the VIPA device are configured correctly.
The “do not queue” setting for DVA contact inputs is described in Table 1 on page 12 and Table 2
on page 15.

If the system is currently configured using the “vipa” configuration file, the settings will be preserved even
after system upgrade, provided the VCT configuration for these settings are not used.
For VCT configuration of Do Not Queue DVA refer to Table 1 on page 12 and Table 2 on page 15.

This rest of this appendix section assumes the VCT configuration is not used.

Overview of “vipa” Configuration File and Settings


The file location is /dva/config/vipa on VIPEDIA-NET or in the /etc/sysconfig/vipa on any other VIPA device.
The ANNOUNCED_EXTRA_OPTIONS line is used to configure these options, which are applied to all
announcements.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 33 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

ANNOUNCED_EXTRA_OPTIONS

This attribute defines routing permissions and is applied to any routes from this VIPA device.

Volume Control

• ANNOUNCED_EXTRA_OPTIONS='--implicit-dva-flags=0x40000'

If enabled, the volume of all routes is controlled by Volume Control devices in the PAVA system.

DVA Streaming

• ANNOUNCED_EXTRA_OPTIONS='--implicit-dva-flags=0x400’

o Disabled: Local and remote VIPA devices will play locally stored DVA.

o Enabled: DVAs will be streamed to local and remote VIPA devices.

Do Not Queue DVA

• ANNOUNCED_EXTRA_OPTIONS='--implicit-dva-flags=0x20’

o Disabled: DVAs will not override routes, even if higher priority. Instead it will be queued until all
target zones are free. The amount of time the DVA is queued is defined in the announce-d DVA
Timeout on the VIPA device's “Advanced Settings” tab.

o Enabled: DVAs will use priority-based routing and will override routes that are lower priority.

Note that this setting will override the “do not queue” setting on DVA contact inputs that is
described in Table 1 on page 12 and Table 2 on page 15.

Examples

The attributes are merged into a single line by adding together the hex number.

• Example 1: Volume control, DVA streaming, and “do not queue” DVA enabled:

ANNOUNCED_EXTRA_OPTIONS='--implicit-dva-flags=0x40420'

• Example 2: Volume control and DVA streaming enabled. “Do not queue” DVA disabled:

ANNOUNCED_EXTRA_OPTIONS='--implicit-dva-flags=0x40400'

• Example 3: DVA streaming and “do not queue” DVA enabled. Volume control disabled:

ANNOUNCED_EXTRA_OPTIONS='--implicit-dva-flags=0x420'

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 34 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

Configuration Procedure

1. Use WinSCP to connect to the device.

Contact ASL for the username and password to log in.

2. Connect to the device using an SSH client such as PuTTY or TeraTerm (note PuTTY can be
launched from WinSCP, if installed).

Contact ASL for the username and password to log in.

3. Set the device to read / write mode:


• On a Network Card the command is: “mount -o remount,rw /dva”.

• On other VIPA devices the command is: “./mountrw.sh”.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 35 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

4. Using WinSCP, modify or create the file named “vipa”:


• On a Network Card this file is in the /dva/config/ folder.
• On other VIPA devices this file is in the /etc/sysconfig/ folder.

If the “vipa” does not exist, create


a new file:
1. In the toolbar above the
VIPA device filesystem
window, click “New”.
2. In the dropdown list, click
“File…”.
3. Enter the file name “vipa” in
the popup window.
4. Click “OK”

To edit the “vipa” file:


1. Right-click the file.
2. In the right-click list, click “Edit”.
3. Click “Edit”.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 36 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

5. Add the ANNOUNCED line as required for the desired settings:

For example:

ANNOUNCED_EXTRA_OPTIONS='--implicit-dva-flags=0x40420'

6. Save the “vipa” file once finished.

7. Using an SSH client, set the device to read only mode:


• On a Network Card the command is “mount -o remount,ro /dva“.

• On other VIPA devices the command is “./mountro.sh”.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 37 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

8. To apply the settings, use the command “rcdva restart”. This will restart all device processes and will
printout “failed” if any errors are detected with a process. If this occurs, repeat steps 3 to 8, double-
checking the formatting and settings in step 5.
The screen shot below shows an example of failed processes due to errors in the “vipa” file.

It is recommended to reinstall the VCT configuration after all configuration


steps in this section are complete.

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 38 of 40
VIPA – VIPEDIA-12 / INTEGRA Contact Inputs – Configuration Guide

Notes

U-0582-4644.docx – Issue: 01 Complete, Approved - Date: 12/12/19


Page 39 of 40

You might also like