Global variables and objects

This page is related to JavaScript.

Introduction

The global variables and the global objects detailed below are particular to SpinetiX platform. They can be used within the JavaScript code (<script> elements, JS files) for different purposes, like:

to display the device information on the screen;
to change the content or behavior based on a global variable value – for instance when the device name is x, display image y;
to access the web storage content.

For instance, the following widgets were build using the global variables:

Global variables

The following JavaScript global variables are available:

DEVICE_NAME
Contains the device name; it is set to "[not defined]" in Elementi.
MULTI_SCREEN_ID
Contains the Multiscreen ID; it is set to "fullscreen" in Elementi.
SERIAL_NUMBER
Contains the player serial number (i.e., its MAC address without the colon separator); it is set to "[not defined]" in Elementi.

Here are some JavaScript examples, using the global variables:

 document.getElementById("MySerialNumberTextBox").textContent = SERIAL_NUMBER;

var uri = document.getElementById( "rss_uri" ).textContent + DEVICE_NAME;

 if ( MULTI_SCREEN_ID=='Tokio' ) {
   // show some type of content
 } else {
   // Show another type of content
 }

Global objects

The following JavaScript global objects are available:

deviceInfo
Object with extended information about the device. See deviceInfo object section below.
document
An SVGDocument object providing access to the SVGGlobal object, to the root element from the DOM tree (document.documentElement) and to the document URI (document.documentURI).
HID
Array of HumanInterfaceDevice objects representing the interfaces exposed by all connected USB HID devices. See the USB I/O API page for more details.
localStorage
Provides access to the localStorage object. See the Web Storage API page for more details.
sessionStorage
Provides access to the sessionStorage object. See the Web Storage API page for more details.
navigator
Navigator object containing the following information:
- userAgent: set to “SpinetiX”
- spxDocumentTime: the document rendering time
- spxWallClock: the date and time of the content
- spxNetworkClock: the date and time of the device/PC
- spxCloudStage: the cloud stage (e.g., “prod”) corresponding to the player/Elementi
- spxLicenseFeatures: object containing details about the software features activated by the current license/Feature Set
- spxAudioPlayer: object containing details about the embedded audio player

this
In the global execution context (outside any function), this refers to the global object. See more about this keyword.
window
The SVGGlobal object containing all the global variables mentioned on this page. When the code is run in a browser, this object may have other properties as well - see Window object for more details.

`deviceInfo` object

The deviceInfo global object contains extended information about the player, or the computer running Elementi. It is available since firmware 3.0.0.

Properties

Property	Value
`deviceName`	The player's device name or "`[not defined]`" in Elementi. It is identical to `DEVICE_NAME` global variable.
`deviceType`	The device hardware type, as following: "`utsubaki`" for iBX440 "`ume`" for iBX410 and iBX410W "`fukiran`" for HMP400 and HMP400W "`ikebana`" for HMP300 and HMP350 "`Sakura`" for HMP200 "`Bonsai`" for HMP130 and HMP100 "`windows`" for Elementi.
`multiScreenId`	The player's multiscreen ID or "`fullscreen`" in Elementi. It is identical to `MULTI_SCREEN_ID` global variable.
`serialNumber`	The player serial number or "`[not defined]`" in Elementi. It is identical to `SERIAL_NUMBER` global variable.
`userSerialNumber`	The user player serial number of HMP400/W players or "`null`" otherwise.
`boardSerialNumber`	The board serial number or "`null`".
`systemSerialNumber`	The system serial number or "`null`".
`chassisSerialNumber`	The chassis serial number or "`null`".
`firmwareVersion`	Contains the player's firmware or Elementi software version. It is formatted as `major.minor.update-releaseBuild.number.internalBuild` (where `releaseBuild` is 0 for betas and 1,2,3... for stable releases).
`hostName`	Contains the hostname of the player, respectively the PC name in Elementi.

Functions

deviceInfo.getNetworkInterfaces()

Function that returns an object mapping the network interfaces and their addresses. The returned object has a property for each interface (e.g., "eth0", "eth1", etc.) whose value is an object with the following information:

running
Boolean set to true when the interface's link is running
type
Type of network interface, one of ethernet, modem, wlan or wwan.
physicalAddress
Physical address of the interface, typically a MAC address.
IPv4Addresses
Array of address objects listing all active IPv4 addresses on that interface. Each object has the following properties:
- address Interface address
- netmask Network mask
- broadcast Broadcast address (optional)
- destination Destination address (only for modems)
IPv6Addresses
Array of address objects listing all active IPv6 addresses on that interface. Each object has the following properties:
- address Interface address
- netmask Network mask