Intel® Technology Access SDK Developer Guide

Intel Confidential

Revision History

Contents

• Revision History
• References and Links
• Abstract
• Introduction
• Target Audience
• Hardware Requirements
• Operating Environments
• Getting Started
• Example usage of Intel® Technology Access SDK calls
• Intel® Technology Access SDK reference
  • Namespace intel
    • Function Details: namespace intel
  • Namespace intel.technologyaccess.sdk (in intel-technologyaccess.js file)
    • Function Details: namespace intel.technologyaccess.sdk (in intel-technologyaccess.js file)
  • Namespace intel.technologyaccess.twoinone (in intel-2in1.js file)
    • Function Details: namespace intel.technologyaccess.twoinone (in intel-2in1.js file)
• Appendix A: Full sample code invoking 2 in 1 sensor
• Appendix B: Troubleshooting
• Legal Information

References and Links

Abstract

The JavaScript* SDK for Intel® Technology Access allows developers to quickly access Intel® Technology Access capabilities, such as the two-in-one sensor.

Introduction

Intel® Technology Access (Intel TA) is a set of REST APIs that enables applications to access platform technologies using web services.

With Intel TA, developers can now:

• Take advantage of leading technologies built into platforms using web services
• Access hardware capabilities to deliver a consistent user experience across multiple computing environments

For detailed information, please see https://software.intel.com/articles/introducing-intel-technology-access.

Abstract

The JavaScript* SDK for Intel® Technology Access allows developers to quickly access Intel® Technology Access capabilities, such as the two-in-one sensor.

Target Audience

The target audience for this document is developers with a working knowledge of JavaScript*.

Hardware Requirements

Any Intel® Atom™ or 4th generation Intel® Core™ processor-based 2 in 1 systems

Operating Environments

• Microsoft Windows* 7 OS (x86, x64) browsers
• Microsoft Windows* 8 and 8.1 Modern OS (x86, x64) web application
• Microsoft Windows* 8 and 8.1 Desktop OS (x86, x64) browsers
• Supported browsers: Mozilla Firefox*, Microsoft Internet Explorer*, and Google Chrome*.

Getting Started

Example usage of Intel® Technology Access SDK calls

Also see Appendix A: Full sample code invoking.

Perform the following steps in order, beginning with Step 1.

1. Link to the SDK files inside the developer’s JavaScript* file. If you stored the SDK files somewhere other than ../www/js/, modify the “src” lines below to reflect the correct location.

   <script type="text/javascript" src="./ITA SDK/intel-technologyaccess.js"></script><script type="text/javascript" src="./ITA SDK/intel-2in1.js"></script>

2. Set variables for the API key, Application name, and access tokens

   var settings = {"apiKey": "xyz123", //Enter your Mashery-generated API key here"applicationName": "FirstApp", // Replace with your app name here"applicationType": "web"
   };
   var RTN, RAT; // access tokens

3. Call SDK using the API key and Application name settings

   var crHandler = intel.technologyaccess.sdk(settings);

4. Create error pairing callback function

   var pairingErrorCallback = function(result) {
   	console.log(result.responseText);
   	$('#pairingOutput').val($('#pairingOutput').val() + 'nPairing Error: ' + result.responseText);
   };

5. Create pairing callback function which retrieves the access token

   var pairingSuccessCallback = function(result) {
   	RAT = result.resourceAccessToken;
   	// Output.
   	$('#pairingOutput').val($('#pairingOutput').val() + 'nPairing Complete: ' + RAT);

6. Create pairing progress callback function

   var pairingProgressCallback = function(result) {
   	RTN = result.id;
   	// Output.
   	$('#pairingOutput').val($('#pairingOutput').val() + 'nPairing Status: ' + result.status);
   };

7. Create 2 in 1 callback function

   var get2in1ValueSuccessCallback = function(result) {
   	console.log(result);
   	$('#2in1Output').val($('#2in1Output').val() + 'n2in1 Mode: ' + result.mode);
   	}

8. Create pairing request

   crHandler.PairDevice(["/sensors/2in1"], ["THIS"], pairingProgressCallback, pairingSuccessCallback, pairingErrorCallback);
   			});

9. Create an object to access 2 in 1 sensor

   var twoinone = intel.technologyaccess.twoinone(settings);

10. Retrieve mode of 2 in 1 sensor

    twoinone.GetValue(RAT, get2in1ValueSuccessCallback, get2in1ValueErrorCallback);

Please note that when this program runs, between steps 8 and 9 a pop-up message will appear on the local machine requesting approval to complete the pairing. The user must accept this pop-up.

Intel® Technology Access SDK reference

Namespace intel

Function Details: namespace intel

Namespace intel.technologyaccess.sdk (in intel-technologyaccess.js file)

Function Details: namespace intel.technologyaccess.sdk (in intel-technlologyaccess.js file)

Namespace intel.technologyaccess.twoinone (in intel-2in1.js file)

Function Details: namespace intel.technologyaccess.twoinone (in intel-2in1.js file)

Appendix A: Full sample code invoking 2 in 1 sensor

1. Replace the value of the “apiKey” and “applicationName” variables below with the Mashery-generated API key and name.
2. Create a folder named “ITA SDK” and copy the jquery.js and the downloaded ITA javascript files into that folder.

Notes: If using Windows* Internet Explorer, please ensure to use version 10 or later.

<!--
Copyright (C) 2014. Intel Corporation All Rights Reserved.

This sample source code, information and materials ("Material") contained herein is owned by Intel Corporation or its suppliers or licensors, and title to such Material remains with Intel Corporation or its suppliers or licensors. The Material contains proprietary information of Intel or its suppliers and licensors. The Material is protected by worldwide copyright laws and treaty provisions. All use of or distribution of the Materials is solely and exclusively governed by the terms of the license agreement located at:  https://software.intel.com/en-us/file/intel-ta-oem-isvpdf. Unless otherwise agreed by Intel in writing, you may not remove or alter this notice or any other notice embedded in the Material by Intel or Intel’s suppliers or licensors in any way.
--><html><head><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"><title>

			Intel(R) Technology Access Sample App
		</title><script src="./ITA SDK/jquery.min.js"></script><!--JavaScript SDK --><!-- Pointing to remote js files --><!--<script type="text/javascript" src="https://api.intel.com/reflector/sdk/js/dist/dev/intel-technologyaccess.js?api-key=xyz123"></script> <!--Enter your API key in place of xyz123--><!--<script type="text/javascript" src="https://api.intel.com/reflector/sdk/js/dist/dev/intel-2in1.js?api-key=xyz123"></script>--> <!-- Enter your API key in place of xyz123 --><!-- Pointing to local js files --><script type="text/javascript" src="./ITA SDK/intel-technologyaccess.js"></script><script type="text/javascript" src="./ITA SDK/intel-2in1.js"></script><!-- intel.technologyacces.sdk callbacks --><script type="text/javascript">
			var RTN, RAT;

			var sdkListenerId, seqNumber, twoInOneListenerId;

			var settings = {
				"apiKey": "xyz123", //Enter your API key here"applicationName": "FirstApp", // Enter your app name here"applicationType": "web"

			};

			//Get an handler for the 'intel.technologyaccess.sdk'
			var crHandler = intel.technologyaccess.sdk(settings);

			// Callbacks.
			var pairingErrorCallback = function(result) {
				console.log(result.responseText);
				$('#pairingOutput').val($('#pairingOutput').val() + 'nPairing Error: ' + result.responseText);
			};

			var pairingSuccessCallback = function(result) {
				RAT = result.resourceAccessToken;
				// Output.
				$('#pairingOutput').val($('#pairingOutput').val() + 'nPairing Complete: ' + RAT);

				/*Showing the hidden controls*/
				$('#twoInOneCalls').show();
				$('#sdkEventListeners').show();
			};

			var pairingProgressCallback = function(result) {
				RTN = result.id;
				// Output.
				$('#pairingOutput').val($('#pairingOutput').val() + 'nPairing Status: ' + result.status);
			};

			var sdkCreateEventListenerErrorCallback = function(result) {
				console.log(result.responseText);
				$('#sdkListenerOutput').val($('#sdkListenerOutput').val() + 'nCreateEventListener Error: ' + result.responseText);

			}


			var sdkCreateEventListenerSuccessCallback = function(result) {
				console.log(result);
				sdkListenerId = result.listenerId;
				seqNumber = result.seqNumber;
				$('#sdkListenerOutput').val($('#sdkListenerOutput').val() + 'nEvent Listener created successfullyn');
				$('#sdkListenerOutput').val($('#sdkListenerOutput').val() + 'nListener Id: ' + sdkListenerId + 'nSequence Number: ' + seqNumber);
			}

			var sdkDeleteEventListenerErrorCallback = function(result) {
				console.log(result.responseText);
				$('#deleteListenerOutput').val($('#deleteListenerOutput').val() + 'nDeleteEventListener Error: ' + result.responseText);

			}

			var sdkDeleteEventListenerSuccessCallback = function(result) {
				console.log(result);
				if(typeof sdkListenerId === 'undefined')
				{
					$('#deleteListenerOutput').val($('#deleteListenerOutput').val() + 'nThe listener id is not created. Please create the listener id by clicking on the CreateEventListener button');
				}
				else
				{
					$('#deleteListenerOutput').val($('#deleteListenerOutput').val() + 'nEvent Listener for ' + sdkListenerId + ' removed successfullyn');
					$('#deleteListenerOutput').val($('#deleteListenerOutput').val() + 'Status: ' + result.status + ' Message: ' + result.message);
				}

			}


			var sdkGetEventsErrorCallback = function(result) {
				console.log(result.responseText);
				$('#getEventsOutput').val($('#getEventsOutput').val() + 'nGetEvents Error: ' + result.responseText);
			}

			var sdkGetEventsSuccessCallback = function(result) {
				console.log(result);
				sdkListenerId = result.listenerId;

				$('#getEventsOutput').val($('#getEventsOutput').val() + 'nnListenerId: ' + sdkListenerId + 'n 2in1 mode: ' + result.event.mode);
			}

			var sdkPollEventsErrorCallback = function(result) {
				console.log(result.responseText);
				$('#pollEventsOutput').val($('#pollEventsOutput').val() + 'nPollEventListener Error: ' + result.responseText);
			}



			var sdkPollEventsSuccessCallback = function(result) {
				console.log(result);
				sdkListenerId = result.listenerId;

				$('#pollEventsOutput').val($('#pollEventsOutput').val() + 'nnListenerId: ' + sdkListenerId + 'n 2in1 mode: ' + result.event.mode);
			}</script><!-- intel.technologyaccess.twoinone callbacks --><script type="text/javascript">

			//Get an handler for the 'intel.technologyaccess.twoinone'
			var twoinone = intel.technologyaccess.twoinone(settings);

			var get2in1ValueErrorCallback = function(result) {
				console.log(result.responseText);
				$('#2in1Output').val($('#2in1Output').val() + result.responseText);
			}

			var get2in1ValueSuccessCallback = function(result) {
				console.log(result);
				$('#2in1Output').val($('#2in1Output').val() + 'n2in1 Mode: ' + result.mode);
			}

			var twoInOneListenerErrorCallback = function(result) {
				console.log(result.responseText);
				$('#2in1ListenerOutput').val($('#2in1ListenerOutput').val() + 'nListen Error:' + result.responseText);
			}

			var twoInOneListenerSuccessCallback = function(result) {
				console.log(result);
				twoInOneListenerId = result.listenerId;
				$('#2in1ListenerOutput').val($('#2in1ListenerOutput').val() + 'nnEvent Listener created successfullyn');
				$('#2in1ListenerOutput').val($('#2in1ListenerOutput').val() + 'nListener Id: ' + twoInOneListenerId + 'n2in1 mode: ' + result.event.mode);
			}

			var twoInOneDeleteListenerErrorCallback = function(result) {
				console.log(result);
				$('#2in1DeleteListenerOutput').val($('#2in1DeleteListenerOutput').val() + 'nDeleteListener Error: ' + result.responseText);
			}

			var twoInOneDeleteListenerSuccessCallback = function(result) {
				console.log(result);
				if(typeof twoInOneListenerId === 'undefined')
				{
					$('#2in1DeleteListenerOutput').val($('#2in1DeleteListenerOutput').val() + 'nThe listener id is not created. Please create the listener id by clicking on the CreateEventListener button');
				}
				else
				{
					$('#2in1DeleteListenerOutput').val($('#2in1DeleteListenerOutput').val() + 'nEvent Listener for ' + twoInOneListenerId + ' removed successfullyn');
					$('#2in1DeleteListenerOutput').val($('#2in1DeleteListenerOutput').val() + 'Status: ' + result.status + ' Message: ' + result.message);
				}
			}</script></head><body><h2>Intel(R) Technology Access Sample App</h2><fieldset id="sdkCalls"><legend>Demonstration of 'intel.technologyaccess.sdk' API calls</legend><fieldset id="sdkPairing"><legend>Pairing</legend><div><h3>Demonstration of Pairing (Initiates the pairing sequence for the provided capabilities on the supplied targets):</h3><div id="controls-container"><button id="begin-pairing-btn">Pair Device</button></div><div><textarea id="pairingOutput" rows="10" style="background-color:#ccc; width:100%;" disabled="disabled">Output:</textarea></div></div></fieldset><hr><fieldset id="sdkEventListeners"><legend>2in1 Event Listeners</legend><div><h3>Demonstration of 2in1 CreateEventListener through SDK handler (Creates a new event listener):</h3><div id="controls-container"><button id="Init-Listener-btn">Create 2in1 event listener</button></div><div><textarea id="sdkListenerOutput" rows="10" style="background-color:#ccc; width:100%;" disabled="disabled">Output:</textarea></div></div><div><h3>Demonstration of 2in1 GetEvents through SDK handler (Gets Events for the event listener that got created):</h3><div id="controls-container"><button id="getevents-btn">2in1 GetEvents</button></div><div><textarea id="getEventsOutput" rows="10" style="background-color:#ccc; width:100%;" disabled="disabled">Output:</textarea></div></div><div><h3>Demonstration of 2in1 DeleteEventListener through SDK handler (Deletes event listener):</h3><div id="controls-container"><button id="Delete-Listener-btn">Delete 2in1 event listener</button></div><div><textarea id="deleteListenerOutput" rows="10" style="background-color:#ccc; width:100%;" disabled="disabled">Output:</textarea></div></div><div><h3>Demonstration of 2in1 PollEventListener through SDK handler (Creates a new event listener and starts polling for the provided capability):</h3><div id="controls-container"><button id="pollevents-btn">2in1 PollEventListener</button></div><div><textarea id="pollEventsOutput" rows="10" style="background-color:#ccc; width:100%;" disabled="disabled">Output:</textarea></div></div></fieldset></fieldset><br/><br/><fieldset id="twoInOneCalls"><legend>Demonstration of 'intel.technologyaccess.twoinone' API calls</legend><div><h3>Demonstration of 2in1 Capability Access (Retrieves the current value of the 2in1 capability):</h3><div id="controls-container"><button id="get-2in1-value-btn">Get Sensor Value</button></div><div><textarea id="2in1Output" rows="10" style="background-color:#ccc; width:100%;" disabled="disabled">Output:</textarea></div></div><div><h3>Demonstration of 2in1 Listener (Creates a new event listener for 2in1 and starts polling):</h3><div id="controls-container"><button id="get-2in1-listener-btn">2in1 Event Listener</button></div><div><textarea id="2in1ListenerOutput" rows="10" style="background-color:#ccc; width:100%;" disabled="disabled">Output:</textarea></div></div><div><h3>Demonstration of 2in1 DeleteEventListener (Deletes an new event listener for 2in1):</h3><div id="controls-container"><button id="get-2in1-deleteListener-btn">2in1 DeleteEventListener</button></div><div><textarea id="2in1DeleteListenerOutput" rows="10" style="background-color:#ccc; width:100%;" disabled="disabled">Output:</textarea></div></div></fieldset><!-- intel.technologyaccess.sdk Event handlers --><script type="text/javascript">

			function hideControls()
			{
				$('#twoInOneCalls').hide();
				$('#sdkEventListeners').hide();

			}

			/*Hiding Controls that are dependent on pairing to complete*/
			hideControls();

			$('#begin-pairing-btn').click(function(e) {
				e.preventDefault();
				// Output.
				$('#pairingOutput').val($('#pairingOutput').val() + 'nBeginning pairing...');
				// Create pairing request.
				crHandler.PairDevice(["/sensors/2in1"], ["THIS"], pairingProgressCallback, pairingSuccessCallback, pairingErrorCallback);
			});

			$('#Init-Listener-btn').click(function(e) {
				e.preventDefault();
				// If the RAT is set attempt to get meta data.
				if (RAT.length > 0) {
					// Get Meta Data.
					console.dir(e);
					crHandler.CreateEventListener(RAT, "sensors", "2in1", sdkCreateEventListenerSuccessCallback, sdkCreateEventListenerErrorCallback);
				}
			});

			$('#getevents-btn').click(function(e) {
				e.preventDefault();
				// If the RAT is set attempt to get meta data.
				if (RAT.length > 0) {
					// Get Meta Data.
					console.dir(e);
					crHandler.GetEvents(RAT, "sensors", "2in1", sdkListenerId, seqNumber, sdkGetEventsSuccessCallback, sdkGetEventsErrorCallback);
				}
			});

			$('#Delete-Listener-btn').click(function(e) {
				e.preventDefault();
				// If the RAT is set attempt to get meta data.
				if (RAT.length > 0) {
					// Get Meta Data.
					console.dir(e);
					crHandler.DeleteEventListener(RAT, "sensors", "2in1", sdkListenerId, sdkDeleteEventListenerSuccessCallback, sdkDeleteEventListenerErrorCallback);
				}
			});


			$('#pollevents-btn').click(function(e) {
				e.preventDefault();
				// If the RAT is set attempt to get meta data.
				if (RAT.length > 0) {
					// Get Meta Data.
					console.dir(e);
					crHandler.PollEventListener(RAT, "sensors", "2in1", sdkPollEventsSuccessCallback, sdkPollEventsErrorCallback);
				}
			});</script><!-- intel.technologyaccess.twoinone Event handlers --><script>

			$('#get-2in1-value-btn').click(function(e) {
				e.preventDefault();
				// If the RAT is set attempt to get meta data.
				if (RAT.length > 0) {
					// Get Meta Data.
					console.dir(e);
					twoinone.GetValue(RAT, get2in1ValueSuccessCallback, get2in1ValueErrorCallback);
				}
			});

			$('#get-2in1-listener-btn').click(function(e) {
				e.preventDefault();
				// If the RAT is set attempt to get meta data.
				if (RAT.length > 0) {
					// Get Meta Data.
					console.dir(e);
					twoinone.Listen(RAT, twoInOneListenerSuccessCallback, twoInOneListenerErrorCallback);
				}
			});

			$('#get-2in1-deleteListener-btn').click(function(e) {
				e.preventDefault();
				// If the RAT is set attempt to get meta data.
				if (RAT.length > 0) {
					// Get Meta Data.
					console.dir(e);
					twoinone.DeleteListener(RAT, twoInOneListenerId, twoInOneDeleteListenerSuccessCallback, twoInOneDeleteListenerErrorCallback);
				}
			});</script></body></html>

Appendix B: Troubleshooting

Q1. How can I see more status information on the SDK calls?
A1. Press “F12” in the browser and then click on the Network tab to display more status information.

Q2. How do I view the output of console.log()?
A2. Press “F12” in the browser and select “Console” in the debugger menu.

Q3. Pairing will not complete, despite following setup instructions carefully.
A3. Ensure that pop-up messages are enabled in your browser.

Legal Information

INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LIABILITY WHATSOEVER AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT.

A "Mission Critical Application" is any application in which failure of the Intel Product could result, directly or indirectly, in personal injury or death. SHOULD YOU PURCHASE OR USE INTEL'S PRODUCTS FOR ANY SUCH MISSION CRITICAL APPLICATION, YOU SHALL INDEMNIFY AND HOLD INTEL AND ITS SUBSIDIARIES, SUBCONTRACTORS AND AFFILIATES, AND THE DIRECTORS, OFFICERS, AND EMPLOYEES OF EACH, HARMLESS AGAINST ALL CLAIMS COSTS, DAMAGES, AND EXPENSES AND REASONABLE ATTORNEYS' FEES ARISING OUT OF, DIRECTLY OR INDIRECTLY, ANY CLAIM OF PRODUCT LIABILITY, PERSONAL INJURY, OR DEATH ARISING IN ANY WAY OUT OF SUCH MISSION CRITICAL APPLICATION, WHETHER OR NOT INTEL OR ITS SUBCONTRACTOR WAS NEGLIGENT IN THE DESIGN, MANUFACTURE, OR WARNING OF THE INTEL PRODUCT OR ANY OF ITS PARTS.

Intel may make changes to specifications and product descriptions at any time, without notice. Designers must not rely on the absence or characteristics of any features or instructions marked "reserved" or "undefined". Intel reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them. The information here is subject to change without notice. Do not finalize a design with this information.

The products described in this document may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request.

Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order.

Copies of documents which have an order number and are referenced in this document, or other Intel literature, may be obtained by calling 1-800-548-4725, or go to: http://www.intel.com/design/literature.htm.

All products, platforms, dates, and figures specified are preliminary based on current expectations, and are subject to change without notice. All dates specified are target dates, are provided for planning purposes only and are subject to change.

This document contains information on products in the design phase of development. Do not finalize a design with this information. Revised information will be published when the product is available. Verify with your local sales office that you have the latest datasheet before finalizing a design.

Intel and the Intel logo are trademarks of Intel Corporation in the U.S. and/or other countries.

Windows is a registered trademark of Microsoft Corporation in the United States and other countries.

*Other names and brands may be claimed as the property of others.

Copyright © 2014 Intel Corporation. All rights reserved.