Niagara Spectrum Gauge


Spectrum Gauge for n4

Overview


Drag and drop the Spectrum Gauge widget from the palette onto your px view. It automatically updates when the point or history value changes. Its completely configurable and easy to use.

Usage


1. Copy the spectrumGauge-ux.jar 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.

tridum grahpic showing spectrum gauge

trend bacnet gauge

Properties


The gauge has a number of configurable properties that can be used to modify look, feel, and functionality. Change the properties as required.

Main Chart Binding:
Set this to an absolute ord, e.g.
station:|slot:/Drivers/NiagaraNetwork/AHU5 or relativized ORD e.g.
slot:AHU5
The ord should point to a numeric point/writable that has a numeric interval extension.

Background Property:

The background (the area within the circular part of the widget) can be changed to a solid color, gradient, image, or null(transparent). The image must reference a file ord reference e.g. file:^myImage.jpg, and fit within the bounds of the widget.

Segment Colors:

There are 3 properties related to the segements.:
Segments: which are the percentage size for each segment
SegmentFilledColors: are the areas which are shaded when the value reaches the segment value
SegmentUnFilledcolors: opposite to segmentFilledColors.

History Binding:

You can bind the gauge to a history reference. Change the properties as required:

1. Set the value binding as normal.

The value binding must be set in order to gather history records for the point.

2. Set the history BQL property.

Examples:

|bql:history:HistoryRollup.rollup(history:RollupInterval 'monthly')|bql:select max

|bql:history:HistoryRollup.rollup(history:RollupInterval 'monthly')|bql:select min

|bql:history:HistoryRollup.rollup(history:RollupInterval 'monthly')|bql:select avg

|bql:history:HistoryRollup.rollup(history:RollupInterval 'monthly')|bql:select sum

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",  // For N4.4 or higher use /module/js/rc/jquery/jquery-3.2.0.min
            "Promise": "/module/js/rc/bluebird/bluebird",

            // these are runtime dependencies
            "hbs": "/module/js/rc/require-handlebars-plugin/hbs", // For N4.4 or higher use /module/js/rc/handlebars/handlebars.min-v4.0.6
            "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/spectrumGauge/rc/spectrumGaugeWidget.run.js'], function (app) {

        app.initialiseSpectrumGaugeWidget({
            backgroundColor: 'transparent',
            canvasBackgroundColor: '#1c1a1c',
            circleColor: '#000000',
            divId: '#widget1',
            fontWeight: 'normal',
            fontFamily: 'Helvetica, Arial, sans-serif',
            historyBql: '',
            historyRefreshInterval: 60000,
            innerRadius: 1.6,
            min: 0,
            max: 100,
            ord: 'station:|slot:/Drivers/NiagaraNetwork/AHU5', // use absolute ord
            precision: '2',
            segments: '10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10',
            segmentUnfilledColors: '#026502, #026502, #026502, #026502, #026502, #026502, #026502, #026502, #026502, #026502, #99990a, #99990a, #cc6600, #cc6600, #710000, #710000, #710000, #710000',
            segmentFilledColors: '#00da00, #00da00, #00da00, #00da00, #00da00, #00da00, #00da00, #00da00, #00da00, #00da00, #FFFF00, #FFFF00, #FF8C00, #FF8C00, #ff0000, #ff0000, #ff0000, #ff0000',
            titleFontColor: '#fff',
            titleFontSize: '34px',
            titleFormat: '%displayName%',
            titleYOffset: 40,
            textXOffset: -1,
            valueFontSize: '40px',
            valueFontColor: '#fff',
            valueFormat: '%out.value%',
            valueTextYOffset: 0,
            valueXOffset: -1,
        });
    });
</script>
</head>  
<!--Gauge to go here-->
<div id="widget1" style="width:300px;height:300px;"></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.

licensing for trend iq vision

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

Sensor Status Bar

niagara status animation

Jumbo Gauge

gauge with numeric point

Floor Plan Zoning

niagara floor plan dashboard

back to more widgets...