Spacecode SDK - Annotated Samples

Annotated Samples - JavaScript
This page presents implementations of the JavaScript API. These lasts are voluntarily verbose and should be considered as an extension of the documentation.

JavaScript API - v1.2

Scan and Light tags

Scan and Light tags
The Spacecode JavaScript API is loaded in the namespace window.Spacecode. The class Device is accessible from this namespace. First create the device, then define the events callbacks, and finally connect the device.
```
var _smartboard = new Spacecode.Device("192.168.1.50");
```

Once connected to the device, automatically ask it to start a scan.

// Event Handling
_smartboard.on('connected', function()
{
    _smartboard.requestScan();
});

As soon as the scan successfully completed, get the last inventory using getLastInventory.

_smartboard.on('scancompleted', function()
{
    _smartboard.getLastInventory(function(inventory)
    {

If the inventory could be retrieved, display the number of tags scanned and pass their UID's to the method startLightingTagsLed.
Note: A null callback is passed as first parameter to improve the readability of this example, but it is highly recommended to create one.
```
        if(inventory != null)
        {
            console.log('Scan Completed: '+ inventory.getNumberTotal() +' tags scanned.');
    
            _smartboard.startLightingTagsLed(null, inventory.getTagsAll());
        }
    });
});
```

When the tags lighting process started, display the UID's of the tags which could not be found or lighted.


_smartboard.on('lightingstarted', function(tagsNotLighted)
{
    console.log('Lighting Started!');
    
    tagsNotLighted.forEach(function(uid)
    {
        console.log(uid + ' not lighted');
    });
});

Finally try to connect to the remote device. If the connection is successful, the event 'connected' is raised (see above).
```
// Connect to the device
_smartboard.connect();
```

Use the KeyPress event of the object document to stop the lighting process and release the connection to the remote device. Note: No callback is given to the method startLightingTagsLed, to improve the readability of this example. It is highly recommended to create one.

// Stop the lighting process and Disconnect the device on KeyPress
document.onkeypress = function()
{
    // "active" only if the device is connected
    if(_smartboard.isConnected())
    {
        _smartboard.stopLightingTagsLed();
        _smartboard.release();
        
        document.onkeypress = null;
    }
};

Continuous Scanning

Continuous Scanning
The Spacecode JavaScript API is loaded in the namespace window.Spacecode. The class Device is accessible from this namespace. First create the device, then define the events callbacks, and finally connect the device.
```
var _smartboard = new Spacecode.Device("192.168.1.50");
```

Once connected to the device, automatically ask it to start a scan.

// Event Handling
_smartboard.on('connected', function()
{
    _smartboard.requestScan();
});

As soon as the scan successfully completed, get the last inventory using getLastInventory.

_smartboard.on('scancompleted', function()
{
    _smartboard.getLastInventory(function(inventory)
    {

Display the number of tags Added, already Present and Removed from the device if the last inventory could be retrieved, and ask the device to start scanning again.

        if(inventory != null)
        {
            console.log('Scan Completed at '+ inventory.getCreationDate());
            console.log(inventory.getNumberAdded() +' tags added');
            console.log(inventory.getNumberPresent() +' tags already present');
            console.log(inventory.getNumberRemoved() +' tags removed');
        }
    });

    _smartboard.requestScan();
});

Define a callback for the events scancancelledbyhost and scanfailed.
Regardless the reason (cancelled or failed), ask the device to start scanning again.

var onScanCancelledOrFailed = function()
{
    console.log('Scan cancelled or failed.');
    _smartboard.requestScan();
};

_smartboard.on('scancancelledbyhost', onScanCancelledOrFailed);
_smartboard.on('scanfailed', onScanCancelledOrFailed);

Finally try to connect to the remote device. If the connection is successful, the event connected is raised (see above).
```
// Connect to the device
_smartboard.connect();
```
Use the KeyPress event of the object document to stop the lighting process and release the connection to the remote device. Note: No callback is given to the method startLightingTagsLed, to improve the readability of this example. It is highly recommended to create one.
```
// Disconnect the device on KeyPress
document.onkeypress = function()
{
    // "active" only if the device is connected
    if(_smartboard.isConnected())
    {
        _smartboard.release();
        
        document.onkeypress = null;
    }
};
```

Annotated Samples - JavaScript

Scan and Light tags

Scan and Light tags

Continuous Scanning

Continuous Scanning