Audio Warn

The AudioWarn symbol is used to play a sound whenever a set threshold is reached. This auditory alert helps draw immediate attention to critical conditions, ensuring timely responses. It’s particularly effective in environments where visual cues might be missed or insufficient.

Starting the Control

The format of all used audio files need to be whitelisted in the web.config file, located in the PI Vision main directory.

Eg., the key <add fileExtension=".mp3" allowed="true" /> needs to be added for mp3 files.

To start the control click on the “Assets” button in the upper left corner of the PI Vision display.

In the upper part select “weruAudioWarn” by clicking on it.

Afterwards the desired attribute from the asset tree or a PI tag could be added to the display via drag and drop. The Audio Warn symbol appears in the display.

Before any sound is played, the user needs to click somewhere on the display to activate the sound playback of the symbol. Therefore, a warning is shown at the top of the PI Vision display repeatedly until the user clicked anywhere.

Configuration

Operator: Sets whether the value needs to exceed or fall under a specified threshold.
Threshold: Sets the threshold which is used for the comparison.
Audio: A dropdown menu of all sounds that are available. The selected sound is played whenever a warning is necessary
Test: This button can be used to manually play the sound to check if the playback is functioning correctly and to hear what the sound sounds like. This feature allows for quick verification and troubleshooting of audio alerts.
Mode: Sets whether the sound should be played Once, Repeated, in a loop or in acknowledged mode. The different modes are described in a separate section.

Modes

Once

If the current value exceeds the set threshold, the sound is played once, and the icon turns red. The icon remains red until the value drops below the threshold, at which point it turns green again. If the value exceeds the threshold again, another sound will be played. However, if multiple values exceed the threshold simultaneously, the sound is still played only once.

Repeat

Similar to the “Once” option, but allowing the user to specify how many times the sound should be played.

Loop

If the threshold is exceeded, the sound is played until the value falls underneath the threshold. There is no option to disable the sound playback within the symbol.

Acknowledged

In this mode, the user can acknowledge the alarm by clicking a button. This button is part of a modal that is shown fullscreen. A hint, that is shown underneath the orange “Warning” text can be configured in the configuration pane.

A logging tag can be specified in the configuration by an admin. If that is activated, the text written in the textbox next to the button are stored in the specified PI Tag. The tag stores a string value with the following content: DisplayName[DisplayID];PITagUsedInTheSymbol;TextBoxContent

This can only be done by an admin on the PI Vision Server:

The logging tag is specified in /PIVision/Scripts/app/editor/symbols/ext/libraries/weruPIVisionSuiteConfig.js

var weruAudioWarn = {
audioFiles: {
//Displayname : Path
'/PIVision/Scripts/app/editor/symbols/ext/sounds/warning_1.mp3': 'Warning 1 (MP3)',
'/PIVision/Scripts/app/editor/symbols/ext/sounds/warning_1.wav': 'Warning 1 (WAV)',
'/PIVision/Scripts/app/editor/symbols/ext/sounds/punch.mp3': 'Punch',
},
loggingTag: '\\\\DAServer\\WPVS.AudioWarn.Logging',
};

Add more sounds

Sounds can be specified in the configuration file by adding more entries to the “audioFiles” object.

Change the Size of the Control

To change the size of the symbol, the first step is to change into edit mode (Icon in the upper right corner) and in a second step to click on the control. The eight appearing dots around the control can be used to adjust the size that everything is visible.

Removing the Control

Before removing the control it is necessary to switch into edit mode (Icon in the upper right corner). Thereafter it is possible to click on the control and press the delete key to remove the control.