Professional Documents
Culture Documents
VIPEDIA 12 VIPA Contacts User Manual
VIPEDIA 12 VIPA Contacts User Manual
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
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.
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.
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.
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.
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.
For information on the monitored setting, refer to the PAVA System Configuration Tool User’s
Manual (U-0701-1583).
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.
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.
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.
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.
5. The Serial Port field is not required but must be defined. Enter any text.
10. Right-click the VIPEDIA-NET in the navigation window, select Add then click Contact Driven Input.
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
Response 3000 ms The period of time to wait for a response from the announcement
Timeout process.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The options related to DVA routing are: DVA, BMB Triggered DVA Reset, and BMB Triggered
DVA Global Reset.
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.
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.
Delay 0 ms The delay between the trigger and the first play of the DVA (in
milliseconds).
Inputs To Reset Not configured The DVA contact inputs this contact will reset when activated.
18. Set the attributes in the “Advanced Optional Settings” tab as required. The available attributes will
depend on the selected contact type.
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.
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 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.
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).
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.
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.
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.
9. Navigate to the VIPA device and select the “Standard Settings” tab.
10. Set “Run announce-d” to Global.
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:
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.
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.
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.
c. Select the “Required Settings” tab of the PMC Output. Ensure that the Type is set to
Dynamic.
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.
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).
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.
• 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.
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.
4. If an Audio Input is not present, right-click the Audio Device item and add an Audio Input.
6. Select the “Advanced Optional Settings” tab and select Audio Groups as required.
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.
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.
• 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'
Configuration Procedure
2. Connect to the device using an SSH client such as PuTTY or TeraTerm (note PuTTY can be
launched from WinSCP, if installed).
For example:
ANNOUNCED_EXTRA_OPTIONS='--implicit-dva-flags=0x40420'
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.
Notes