Niagara Toggle Switch Button


Overview


The toggle switch button has a few configurable properties that can be used to modify look, feel, and functionality. The widget binds to a Boolean Writable. You can control the value and get a real time update of its state. So if the boolean is true, the toggle will be off, and vice versa. Before you start, copy the toggleSwitchButton-ux.jar module file to your modules directory. Restart station and Workbench.

Usage


1. Copy the toggleSwitchButton-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.

Boolean Toggle Switch

boolean writeable

Properties


The toggle button has one main property, the ord. It should point to a boolean writable.

This can be an absolute ord, e.g. station:|slot:/Drivers/NiagaraNetwork/AHU5 OR relativized ORD e.g. slot:AHU5

Styling


Button Style:

The button has the following styles:


Boolean Toggle Switch Style

Button Size:

The button has the following sizes. To set the size, set the button size property either toggle, toggle-sm, or toggle-lg


Boolean Toggle Switch Size

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:/../../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 type="text/javascript"
        src="/module/js/com/tridium/js/ext/require/require.min.js"></script>
<script>
    require(['/module/toggleSwitchButton/rc/toggleSwitchButton.run.js'], function (app) {

        app.initialiseToggleSwitchButton({
            backroundColor: 'transparent',
            ord: 'station:|slot:/Drivers/NiagaraNetwork/AHU1_on_off', // use absolute ord
            size: 'toggle', // possible values toggle, toggle-sm, toggle-lg
            style: 'toggle-primary',
            divId: '#widget1'
        });
    });
</script>
</head>  
<!--Rest of your html below...-->
    <div id="widget1" style="width:50px;height:35px;"></div>
                                


Performance Test


Performance Test...

Help


Additional help and guidance can be found in the help file.

niagara ax help


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 software license

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

Alarm Notification Icon

niagara alarms table

Scada Alarm Widget

niagara scada alarm widget

Alarm Acknowledge Table

alarm acknowledge table

back to more widgets...