Javascript Library Documentation

Index

1. Introduction
2. Control
3. Property Functions
4. Functions
5. Callbacks
6. Discovery message
7. Version History

1. Introduction

This document describes all the variables and functions for the Webifi Javascript Library. The Javascript library is used by adding the following line to your HTML file:
<script type=”text/javascript” src=”http://webifi.me/Webifi-min-1.0.js”></script>
The second important thing is to create the Webifi object in your page load function.

webifi = WebifiCreate();  //remember to create a global variable: var webifi;

We have a tutorial for using the Javascript library here, the source code can be downloaded at https://github.com/webifi-me/WebifiJavascriptTutorial. We also have a full featured example available at https://github.com/webifi-me/WebifiJavascriptExample.

2. Control

For the user’s convenience the library can create a control for entering the user’s information and starting the service. It is not necessary for the user to create this control, you can create your own controls and use the API calls to have the same functionality as this control. This control is very convenient to get started quickly. In your HTML file you need an empty div where you would like the control to be:

<div id="webifiControl"></div>

Next we need to create the control in your page load function. We use jQuery in our examples. At this point our page load function will look like this:

var webifi;  //this will reference the Webifi library
$(function () {
  webifi = WebifiCreate();
  webifi.WebifiControl("webifiControl");
});

The control that was created should look like this:

The look of the control can be changed using CSS and Javascript. Multiple instances of the control can be created. For the first control the following IDs have been assigned:

Have a look at our Test Page to see how this is implemented.

3. Property Functions and Variables

var counters = webifi.GetCounters();
var downCnt = counters.download;
var upCnt = counters.upload;

In the example below we set all the credentials needed for a connection:

webifi = WebifiCreate();
webifi.SetConnectName("webifi");
webifi.SetConnectPassword("12345678");
var networkNames = [];
networkNames.push("network 1");
webifi.SetNetworkNames(networkNames);

There are two variables that are useful to the user:

4. Functions

webifi.CreateSendData = function ()
{
  var sendData = {};
  sendData.data = "";
  sendData.dataType = "";
  sendData.toSessionIDs = [];
  sendData.toNetworks = [];
  return sendData;
}

5. Callbacks

The following functions are used to set the callbacks for the Javacript Library:

Below is an example of how the callbacks are used (This page uses a jQuery function for it’s page load event):

var webifi;

//this function runs when the page is finished loading
$(function () {
  webifi = WebifiCreate();

  //set callbacks
  webifi.SetDataReceivedCallback(RecDataCallback);
  webifi.SetConnectionStatusCallback(ConnectionMessageCallback);
  webifi.SetErrorCallback(ErrorCallback);

  //generate the Webifi control
  //there needs to be a div with an id set to "webifiControl" for this to work
  webifi.WebifiControl("webifiControl"); 
  webifi.SetConnectName("webifi");
  webifi.SetConnectPassword("12345678");
  var networkNames = [];
  networkNames.push("network 1");
  networkNames.push("network 2");
  webifi.SetNetworkNames(networkNames);
});

//callback functions
function RecDataCallback(data, dataType, from, sender) {
  //process received data
}

function ErrorCallback(errorCode, sender) {
  var errorMessage = webifi.ConvertErrorCodeToString(errorCode);
  //code to display error message
}

function ConnectionMessageCallback(connected, sender) {
  var message;
  if (connected) {
    message = "Connection successful";
    //user code if connection successful
  } else {
    //there was an error, get the error message
    message = "Connection error: " + webifi.ConvertErrorCodeToString(error);
    //process connection failed
  }
}

6. Discovery message

The session IDs are dynamically assigned to devices connecting to the Webifi server. If you need to send data to a specific device or devices then you need to know their session IDs. The discovery message is an easy way to find the session IDs of all your connected devices. When you call the Send Discovery function the following message will be sent:

• Data type: Discovery
• Data: ? (A question mark character needs to be sent)
• To networks: When empty then the discovery message will be sent to the default networks the sending device is listening to. If an array of networks are specified then all the discoverable devices on these networks will respond.

There isn’t a special event handler for the discovery response, the responses will be received by the data received event. This gives the most flexibility for the user to process the discovery responses any way the user needs. The discovery response looks as follows:

• Data type: Discovery Response
• Data: User defined name on the responding device
• From session ID: The session ID that was discovered. This needs to be stored by the device doing the discovery.

Below is an example of how the discovery can be implemented by the user:

function RecDataCallback(data, dataType, from, sender) {
  //check if a discovery response was received
  if (dataType == "Discovery Response") {
    //device discovered, name will be in data and the session ID will be in the from variable
  }
  else {
    //data was received, process...
  }
}

7. Version History