Alarm Notification Icon


Alarm Notification Icon

Overview


The alarm notification icon displays a heartbit when there are alarms in an alarm state. The animation only occurs when there are alarms to check. You can use a custom image and when clicked, you'll be redirected to an ord of your choice. The widget has a number of configurable properties that can be used to modify look, feel, and functionality. Also check out the Alarm View Template.

Usage


1. Copy the alarmNotificationIcon-ux file to your modules directory.
2. Open the module from your palette file.
3. Drag and drop the widget from the palette onto your px view.

Alarm Notification Icon

Widget Properties

Properties


The widget has a few configurable properties that can be used to modify look, feel, and functionality. Change the properties as required:

Link: The link property should point to an appropriate station asset.
Workbench/PX example: station:|slot:/Services/AlarmService/ConsoleRecipient
HTML Page: /ord?station:%7Cslot:/Services/AlarmService/ConsoleRecipient

Alarm Class: Set the appropriate Alarm Class. Default is defaultAlarmClass.

Alarm Icon: Set this to use your own image. E.g. file:^indicatorlight.png

Background Color: The default is transparent. If your px/html page has a different color, set this property to match it.

Using in your HTML Page


You can now use the widget in your custom html page as long as the html file is in a appropriate station directory.
E.g. C:/../stationName/shared/webfiles/demo1.html

1. Create an html page and place in your station files directory.
2. Create a div element and give it an id so you can inject the widget into this area. E.g.: widget1.
3. Add the following scripts before the closing head tag or the closing body tag. E.g.:


<script type="text/javascript">

    var require = {
        paths: {
            "nmodule": "/module",
            "baja": "/module/bajaScript/rc/plugin/baja",
            "bajaScript": "/module/bajaScript/rc",
            "bajaux": "/module/bajaux/rc",
            "lex": "/module/js/rc/lex/lexplugin",
            "css": "/module/js/com/tridium/js/ext/require/css",

            "jquery": "/module/js/rc/jquery/jquery-2.1.1",
            "Promise": "/module/js/rc/bluebird/bluebird",

            // these are runtime dependencies
            "hbs": "/module/js/rc/require-handlebars-plugin/hbs",
            "i18nprecompile": "/module/js/rc/require-handlebars-plugin/hbs/i18nprecompile",
            "json2": "/module/js/rc/require-handlebars-plugin/hbs/json2",
            "underscore": "/module/js/rc/underscore/underscore",
        },

        hbs: {
            disableI18n: true
        }
    }
</script>
<script type="text/javascript" src="/module/js/com/tridium/js/ext/require/require.min.js"></script>
<script>
    require(['/module/alarmNotificationIcon/rc/alarmNotificationIconWidget.run.js'], function (app) {

        app.initialiseAlarmNotificationIcon({
            alarmIconStyle: 'alarm-grey-1x',  //alarm-grey-1x, alarm-grey-2x, alarm-grey-3x, 
            //alarm-white - 1x, alarm-white - 2x, alarm-white - 3x when own image not used
            alarmNotifyPositionTop: '-28px',
            alarmNotifyPositionRight: '2px',
            alarmColor: '#fc4b6c',
            backgroundColor: 'transparent',
            class: 'defaultAlarmClass', // Alarm Class defined in station. Default is defaultAlarmClass.
            divId: '#widget1',
            heartbitWidth: '16px',
            heartbitHeight: '16px',
            heartbitTop: '-20px',
            heartbitRight: '-4px',
            imageOrd: '', // e.g. file:^indicatorlight.png
            link: '/ord?station:%7Cslot:/Services/AlarmService/ConsoleRecipient',
        });
    });
</script>
</head>  
<div id="widget1" style="width:33px;height:33px;padding:10px;"></div>
<!--Rest of your html below...-->
                                

Licensing


Widgets and drivers must be licensed with us. Licenses are bound to the stations host Id. You will be provided access to the Software and Licensing Portal where you can manage your own licenses. Here you can add, update, or delete licenses as needed.

There are few ways to get a license file:

1. Add our licensing module to your station services. This module automatically retrieves the license from our servers and saves it to your stations shared folder directory.

2. Alternatively, Login to the Software and Licensing Portal (link provided in Order Confirmation) and add your host id's as needed. Copy the license file to the stations shared directory.

Finally, make sure the station user has access to WLicenseService in the user management and category service section.

Niagara Licensing

Niagara Dashboard


Niagara IOT technologies and modern toolsets allow you to build a powerful Niagara dashboard which is real time, data-driven, and cost effective. Our widgets are purpose-built by providing information with faster communication through real-time, data-driven, dashboards for web, desktop and mobile devices. You can now create a cutting-edge display of conventional HVAC system graphics, Dashboards, Alarms & Scheduling, Historical Data, and Analytics.

You May Also Like

Time Schedule Widget

Scada Alarm Widget

Alarm Acknowledge Table


back to more widgets...