Device info API

1. Introduction

ZEASN developed a device info API which can be used to identify the client devices and show key device properties. This document describes the available properties and how to get access to them.

2. Device info API

The Device info API can only be used on a real ZEASN certified device. In case it was used on a non-ZEASN certified device, the property will be set to “unknown” which is a default value.

2.1 Available device info data

2.2 Implementation

To be able to access the device info, you have to add an external JS file which will allow you to read them via an external object.

 <script src="<base_URL>zeasn_deviceInfo_sdk.js" type="text/javascript" />

· PROD: https://cache.zeasn.tv/webstatic/homepage_web/deviceinfo/zeasn_deviceInfo_sdk.js 

2.2.1 Object

After adding this external JS file, you will be able to read the properties using an object "DeviceInfo" and sub objects "Channel", "Product" and "Capability". The properties can be read using the object as below using callback "window.onDeviceInfoReady".

Example to show all properties:

window.onDeviceInfoReady(function(DeviceInfo) {      logEl.innerHTML = JSON.stringify(DeviceInfo, null, 2)    })

DeviceInfo.Channel.appStore; 

DeviceInfo.Product.year;

DeviceInfo.Capability.support3d;

Based on device info properties, app providers can do the diversity handling.

2.3 Device ID formats

The ZEASN device ID information can be in different formats, some of the formats are out of our control because they are provided by the Smart TV manufacturers in their own format and by their own local objects. If there is no possible way of uniquely identifying devices based on a unique identifier from the manufacturer, we provide it by creating a unique cookie value. Serving as the ZEASN fallback mechanism.

The ZEASN fallback will generate a unique value. Example: 663653e7-f9a7-8721-43b0-ff9de6250668

Possible formats:

* depending TV models and years it could happen that older devices do not yet have a value from the manufacturer of the device.