• Overview
• Browser and Device Compatibility
• A code sample to get you started
• JavaScript API Details
• Attributions
• See it working in this page!

The Intel Web APIs are implemented as browser plugins. In order to avoid requiring the viewers of web pages with these plugins to individually download and install the plugins, the Connector simplifies this chore without compromising the viewer's control and security.

When first visting a site using Intel Web APIs, the viewer of the page will be directed to install the Connector. This installation is like any other plugin installation - download the installer, run it, and restart the browser. After this, however, the viewer experiences much different behavior with Intel Web API web pages. Upon subsequent visits to a page with Intel Web APIs, the web page will request that the Connector download and install any required Intel Web APIs. This occurs without the viewer performing the steps manually - so no longer does the viewer need to download, run, and restart.

Instead, after the Connector is installed, the viewer will be prompted to allow or deny each web site requesting other Intel Web APIs. This ensures the viewer remains in control of which web sites can and cannot use Intel Web APIs on his or her machine. The Connector allows the viewer to establish both per-session and permenant whitelists and blacklists. In otherwords, known good and known bad sites.

In addition to viewer-controlled white and black lists, the Connector also refuses to download and install plugins that are not digitally signed by the folks here at Intel working on Intel Web APIs - we don't want a rouge web site to instruct the Connector to download any random plugin!

The table below lists some compatability notes for browser and operating system combinations.

If you are interested in seeing these APIs available on other device types and operating systems please let us know by leaving comments.

This HTML & JavaScript shows you how to embed the Intel Connector Web API into your app.

  <div id="IntelWebAPIs_sample_code_status_div" 
    ></div>
  <script 
    type="text/javascript" 
    src="http://software.intel.com/sites/whatif/webapis/intelwebapis.js">
  </script>
  
  <script type="text/javascript">
  
    // this outer closure just to keep the sample code from cluttering up
    // the namespace with the function names etc being used
    (function() {
      
      //kick off IntelWebAPIs.init() and IntelWebAPIs.require() when
      //the page is loaded
      add_onload_handler( function() {
  
        IntelWebAPIs.init(init_result_func);
        
        //called by IntelWebAPIs.init()
        function init_result_func(result) {
          if(result.success) {
            // now bring in Intel Web APIs required by your app...
            output_status("IntelWebAPIs Connector init success: version " +
                          IntelWebAPIs.connector.version);
          }
          else {
            output_status("IntelWebAPIs Connector init error: " + result.error.msg);
            //handle error condition
            //result.error.msg contains an error message
            //result.connectorInstUrl contains the url to the Intel Web API connector installer
            output_status("you may need to download the Intel Web API connector from here: " + 
              result.connectorInstUrl);
          }
        }
      });     
      
      /* Its recommended that you wait until the document is loaded 
         before calling IntelWebAPIs.init() and IntelWebAPIs.require() 
         This utility helps with that...*/
      function add_onload_handler(addfunc, altwindow) {
        var targwindow = window;
        if(typeof(altwindow) != 'undefined'){
          targwindow = altwindow;
        }
        
        /* chain the onload functions together */
        var prevf = targwindow.onload;
        var newf  = addfunc;
        targwindow.onload = function(){
            newf();
            if(typeof(prevf) == 'function'){
              prevf();
            }
          };
      }
      
      /* utility that outputs status messages to a div*/
      function output_status(str) {
        var divout = document.getElementById("IntelWebAPIs_sample_code_status_div");
        divout.innerHTML += str + "<br/>";
        divout.scrollTop = divout.scrollHeight;
      }
    })(); // end of outer closure
  </script>

Th Object that is passed into callback for the init() function is formatted as follows:

  result = { 
    success           : boolean,
    
    // these fields are valid if success != true
    connectorInstUrl  : string 
    error             : {
      msg             : string 
    } 
  }

  IntelWebAPIs.connector = {
    'version'     : string
  };

Intel Connector Web API uses the following software components:

• OpenSSL: This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/). Copyright (c) 1998-2008 The OpenSSL Project. All rights reserved.
• JSONXX: Copyright (c) 2010 Hong Jiang Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

• Overview
• Browser and Device Compatibility
• A code sample to get you started
• JavaScript API Details
• See it working in this page!

When web apps have the ability to learn about the characteristics of the device's network connection they are be able to make use of that information to create a better experience for the user.

For instance, in combination with other information about the device, a web app might use connection information to request a video stream which is approprate for the device's current bandwidth capability. A web app may determine that current signal strength is not sufficient for the app to function appropriatly for the desired user experience - and may prompt the user re-orient the device or move closer to a wireless access point.

The table below lists some compatability notes for browser and operating system combinations.

If you are interested in seeing these APIs available on other device types and operating systems please let us know by leaving comments.

This HTML & JavaScript shows you how to embed the Intel Connection Web API into your app.

  <div id="IntelWebAPIs_sample_code_status_div" 
    ></div>
  <script 
    type="text/javascript" 
    src="http://software.intel.com/sites/whatif/webapis/intelwebapis.js">
  </script>
  <script type="text/javascript">

    // this outer closure just to keep the sample code from cluttering up
    // the namespace with the function names etc being used
    (function() {
      
      //kick off IntelWebAPIs.init() and IntelWebAPIs.require() when
      //the page is loaded
      add_onload_handler( function() {

        IntelWebAPIs.init(init_result_func);
        
        //called by IntelWebAPIs.init()
        function init_result_func(result) {
          if(result.success) {
            // now bring in Intel Web APIs required by your app...
            output_status("IntelWebAPIs Connector init success");
            IntelWebAPIs.require(["connection"], require_completion_func, require_progress_func);
          }
          else {
            output_status("IntelWebAPIs Connector init error: " + result.error.msg);
            //handle error condition
            //result.error.msg contains an error message
            //result.connectorInstUrl contains the url to the Intel Web API connector installer
            output_status("you may need to download the Intel Web API connector from here: " + 
              result.connectorInstUrl);
          }
        }
    
        //called by IntelWebAPIs.require()
        function require_completion_func(result) {
          if(result.success){
            //you can now use IntelWebAPIs.connection properties and functions
            output_status("IntelWebAPIs." + result.installInfo.plugins[0].name + " ready for use!");
            setInterval(function(){
              // send a status message to our div every second
              var connInfo = IntelWebAPIs.connection.getConnectionInfo();
              output_status("Wifi connected=" + connInfo.wifi.connected);
              output_status("Wifi signal strength=" + connInfo.wifi.signalStrength);
            },1000);
          }
          else {
            //check other result properties and handle error condition
            output_status("IntelWebAPIs error: " + result.installInfo.msg);
          }
        }
        
        //called by IntelWebAPIs.require()
        function require_progress_func(statusMsg){
          //statusMsg is a string - send this wherever
          output_status("IntelWebAPIs connector status: " + statusMsg);
        }
      
      });
      
      /* Its recommended that you wait until the document is loaded 
         before calling IntelWebAPIs.init() and IntelWebAPIs.require() 
         This utility helps with that...*/
      function add_onload_handler(addfunc, altwindow) {
        var targwindow = window;
        if(typeof(altwindow) != 'undefined'){
          targwindow = altwindow;
        }
        
        /* chain the onload functions together */
        var prevf = targwindow.onload;
        var newf  = addfunc;
        targwindow.onload = function(){
            newf();
            if(typeof(prevf) == 'function'){
              prevf();
            }
          };
      }
      
      /* utility that outputs status messages to a div*/
      function output_status(str) {
        var divout = document.getElementById("IntelWebAPIs_sample_code_status_div");
        divout.innerHTML += str + "<br/>";
        divout.scrollTop = divout.scrollHeight;
      }
    })(); // end of outer closure
  </script>

This is the result Object that is passed into init_result_func(result).
If the Intel Web API Connector is not yet installed on a user's device you can use the result.connectorInstUrl to prompt the user, in the context of your app, to install it.
Once the Intel Web API Connector is installed other apis are installed by the connector, with minimal user interruption, when your app calls IntelWebAPIs.require().

  result = { 
    success           : boolean,
    
    // these fields are valid if success != true
    connectorInstUrl  : string 
    error             : {
      msg             : string 
    } 
  }

  result = { 
    success       : boolean,
    
    installInfo   : {
      msg         : string,
      
      plugins     : [ { 
        name      : string,
        installed : boolean,
        details   : string
        }, 
        //...
      ], 
    }
  }  

  IntelWebAPIs.connection = {
    'version'             : string,
    'connected'           : boolean,
    'getConnectionInfo'   : function
  };

  connectionInfo =  {
    'lan'         : {
      'connected'       : boolean,
      'signalStrength'  : number,     //will be 100 if connected, 0 if not connected
      'linkSpeed'       : number      //kbps in 100bps or 0 if unknown or disconnected
    },
    'wifi'        : {
      'connected'       : boolean
      'signalStrength'  : number,     //RSSI signal strength as a percent or -1 if unknown. 
                                      // signal strength is 0 when disconnected.
      'linkSpeed'       : number      //kbps in 100bps or 0 if unknown or disconnected
    }
  }

  function output_connected(){
    alert("connected = " + IntelWebAPIs.connection.connected);      
  }
  
  function output_connection_info() {
    var conninfo = IntelWebAPIs.connection.getConnectionInfo();
    alert("lan.connected="        + conninfo['lan']['connected']);  
    alert("lan.signalStrength="   + conninfo['lan']['signalStrength']);
    alert("lan.linkSpeed="        + conninfo['lan']['linkSpeed']);

    alert("wifi.connected="       + conninfo['wifi']['connected']);  
    alert("wifi.signalStrength="  + conninfo['wifi']['signalStrength']);
    alert("wifi.linkSpeed="       + conninfo['wifi']['linkSpeed']);
  }

• Overview
• Check out the mashup!

This mashup demonstrates using the Intel CPU/Power/Connection Indicator Widget in a page that includes a video player.

The goal of the mashup is to help the user avoid a choppy and/or interrupted viewing experience - due to CPU load being too high, too little battery time remaining or poor network signal strength.

We put the mashup in its own page to give it a more "realistic" look and feel :)
When you go to the page be sure to look at the page source to see how we embedded the widget and player. To see other examples of how to embed the CPU Power Connection Indicator widget go to the widget's page here.