Java Script Objects For Bright (6.0)
2016-02-03
: Brightsign Javascript Objects For Brightscript (6.0) JavaScript Objects for BrightScript (6.0) s
Open the PDF directly: View PDF
.
Page Count: 29
| Download | |
| Open PDF In Browser | View PDF |
TECHNICAL NOTES
Using JavaScript Objects for BrightScript
(FW 6.0.x)
BrightSign, LLC. 16780 Lark Ave., Suite B Los Gatos, CA 95032
408-852-9263 | www.brightsign.biz
TABLE OF CONTENTS
Enabling BrightScript JavaScript Objects..................................... 3
BSControlPort ............................................................................. 5
BSDatagramSocket ..................................................................... 8
BSDeviceInfo .............................................................................. 9
BSIRReceiver............................................................................ 11
BSIRTransmitter ........................................................................ 13
BSVideoMode ........................................................................... 14
BSCECTransmitter .................................................................... 16
BSCECReceiver ........................................................................ 17
BSSyncManager ....................................................................... 18
BSMessagePort ........................................................................ 21
BSSerialPort.............................................................................. 23
BSTicker ................................................................................... 25
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
1
INTRODUCTION
The BrightSign HTML engine exposes several JavaScript objects for BrightScript.
These objects allow you to link many standard interactive, database, and hardware
elements (serial, CEC, device info, etc.) to HTML pages. This tech note details the
functions and parameters for each JavaScript object. For more information about the
BrightScript objects that the JavaScript objects are linked to, see the BrightScript
Object Reference Manual.
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
2
Enabling BrightScript JavaScript Objects
For security reasons, all BrightScript JavaScript objects are disabled by default. As a result, you will
encounter DOM errors like those shown below if you do not enable first enable them (to view a
console log of BrightScript/JavaScript events, navigate to the Diagnostic Web Server or use
the JavaScript console).
Follow the below steps to enable BrightScript JavaScript objects.
If Using BrightAuthor to Display HTML
Make sure that you are using BrightAuthor version 4.1 or later. Earlier versions do not have the code
that enables BrightScript objects for JavaScript.
Also, ensure that the Enable external data box is checked within the HTML5 state that is displaying
your page.
If displaying HTML using BrightScript
Call the AllowJavaScriptUrls() method on the roHtmlWidget instance you are using to display
the page. This method accepts an associative array that maps JavaScript BrightScript classes to the
URL(s) that are allowed to use them.
• An all key indicates that all classes are authorized for the associated URL(s).
• An asterisk "*" value indicates that all URLs are authorized for the associated BrightScript
class.
• A "local" value indicates that all local pages are authorized for the associated BrightScript
class.
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
3
Example: The following will enable all BrightScript classes for all URLs.
html.AllowJavaScriptUrls({ all: "*" })
Example: The following will enable all BrightScript classes for local pages and the BrightSign homepage.
html.AllowJavaScriptUrls({ all: "local", "http://www.brightsign.biz" })
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
4
BSControlPort
For more information about available methods, refer to the Object Reference Manual entries on
roControlPort and roGpioControlPort.
Object Creation
BSControlPort(in DOMString PortName);
Methods
• boolean
• boolean
in
in
in
• boolean
in
• boolean
• boolean
SetOutputValue(in unsigned long Param)
SetOutputValues(in unsigned long Param1,
unsigned long Param2,
unsigned long Param3,
unsigned long Param4)
SetPinValue(in unsigned long Pin,
unsigned long Param)
ConfigureAsInput (in unsigned long Pin);
ConfigureAsOutput (unsigned long Pin);
Events
The following events are available on the BSControlPort object. Each event can receive a
ControlPortEvent event.
• oncontroldown
• oncontrolup
• oncontrolevent
ControlPortEvent – Attributes
• readonly attribute unsigned long code
Example
The following JavaScript example causes the LEDs on a BP900 button board to twinkle:
var bp900_gpio;
function myFunction()
{
var bp900_setup = new BSControlPort("TouchBoard-0-LED-SETUP");
bp900_setup.SetPinValue(0, 11)
var bp900 = new BSControlPort("TouchBoard-0-LED");
bp900.SetPinValue(0, 0x07fe)
bp900.SetPinValue(1, 0x07fd)
bp900.SetPinValue(2, 0x07fb)
bp900.SetPinValue(3, 0x07f7)
bp900.SetPinValue(4, 0x07ef)
bp900.SetPinValue(5, 0x07df)
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
5
bp900.SetPinValue(6, 0x07bf)
bp900.SetPinValue(7, 0x077f)
bp900.SetPinValue(8, 0x06ff)
bp900.SetPinValue(9, 0x05ff)
bp900.SetPinValue(10, 0x03ff)
}
bp900_gpio = new BSControlPort("TouchBoard-0-GPIO");
bp900_gpio.oncontroldown = function(e)
{
console.log('###### oncontroldown' + e.code);
}
Example
The following example displays events from a GPIO expander board. Note that using the equivalent
roGpioControlPort object in BrightScript at the same time will result in unpredictable I/O behavior.
GPIO/Expander Test Page
Note this does NOT play well with roGpioControlPort!!
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
7
BSDatagramSocket
For more information about available methods, refer to the Object Reference Manual entry on
roDatagramReceiver and roDatagramEvent.
Methods
• boolean BindLocalPort(in unsigned long portNumber)
• long GetLocalPort()
• boolean JoinMulticastGroup(in DOMString group)
• boolean SendTo(in DOMString dest,
in long port,
in ArrayBufferView data)
• boolean SendTo(in DOMString dest,
in long port,
in DOMString data)
Events
The following event is available on the BSDatagramSocket object. It can receive an event of the type
DatagramSocketEvent. Use GetBytes() to retrieve the body of the UDP message.
• ondatagram
DatagramSocketEvent
The DatagramSocketEvent has the following attributes:
• readonly attribute DOMString remoteHost
• readonly attribute int remotePort
The DatagramSocketEvent supports the following methods:
• ArrayBuffer getBytes()
Example
var bsSocketMessage = new BSDatagramSocket();
bsSocketMessage.BindLocalPort(1234)
bsSocketMessage.ondatagram = function(e){
console.log(e);
};
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
8
BSDeviceInfo
For more information about available methods, refer to the Object Reference Manual entry on
roDeviceInfo.
Attributes
• readonly
• readonly
• readonly
• readonly
• readonly
• readonly
• readonly
• readonly
attribute
attribute
attribute
attribute
attribute
attribute
attribute
attribute
DOMString model
DOMString version
int deviceUptime
int deviceLifetime
int deviceBootCount
DOMString bootVersion
DOMString deviceUniqueId
DOMString family
Methods
• int VersionCompare(in DOMString version)
• int BootVersionCompare(in DOMString version)
• boolean HasFeature(in DOMString feature)
Example
The following JavaScript example posts device information on the page when the button is clicked:
function deviceInfo()
{
var device_info = new BSDeviceInfo();
document.getElementById("modelText").innerHTML = device_info.model;
document.getElementById("versionText").innerHTML = device_info.version;
document.getElementById("bversionText").innerHTML = device_info.bootVersion;
document.getElementById("serialText").innerHTML = device_info.deviceUniqueId;
document.getElementById("familyText").innerHTML = device_info.family;
document.getElementById("uptime").innerHTML = device_info.deviceUptime;
document.getElementById("lifetime").innerHTML = device_info.deviceLifetime;
document.getElementById("bootcount").innerHTML = device_info.deviceBootCount;
if(device_info.VersionCompare("4.7.36") > 0)
{
document.getElementById("version1").innerHTML = "Version > 4.7.36"
}
else
{
document.getElementById("version1").innerHTML = "Version <= 4.7.36"
}
if(device_info.HasFeature("Six Channel Audio"))
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
9
{
document.getElementById("feature").innerHTML = "6 Channel Audio
Available"
}
else
{
document.getElementById("feature").innerHTML = "6 Channel Audio NOT
Available"
}
}
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
10
BSIRReceiver
This class receives IR events. For more information, refer to the Object Reference Manual entry on
roIRReceiver.
Object Creation
A BSIRReceiver object must specify the hardware interface that will receive IR events, as well as the
encoding(s) to look for:
BSIRReceiver(in DOMString interface, in DOMString encodings);
Valid hardware interfaces include the following:
• "GPIO": Pin 1 of the GPIO connector
• "IR-in": The 3.5mm IR input/output connector (available on the 4K series of players)
• "Iguana": The Iguanaworks IR transceiver. This source can support both NEC and RC5
encodings simultaneously.
Valid encodings include the following (multiple encodings can be specified in the string using a ";"):
• "NEC"
• "RC5" (supported on the Iguanaworks device only)
Events
These events are available on the BSIRReceiver object. Each event can receive an
IRReceiverEvent event.
• onremotedown
• onremoterepeat
• onremoteup (supported on the Iguanaworks device only)
IRReceiverEvent – Attributes
• readonly attribute DOMString irType;
• readonly attribute unsigned long code;
Example
The following JavaScript example displays messages on the log when receiving remote codes:
function myFunction()
{
var ir_receiver = new BSIRReceiver();
ir_receiver.onremotedown = function(e){
console.log('############ onremotedown: ' + e.irType + " - " + e.code);
}
ir_receiver.onremoteup = function(e){
console.log('############ onremoteup: ' + e.irType + " - " + e.code);
}
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
11
}
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
12
BSIRTransmitter
For more information about available methods, refer to the Object Reference Manual entry on
roIRTransmitter.
Object Creation
A BSIRTransmitter object must specify the hardware interface that will output the IR signal:
BSIRTransmitter (in DOMString interface);
Valid hardware interfaces include the following:
• "IR-out": The 3.5mm IR input connector (available on XD players) or 3.5mm IR input/output
connector (available on 4K players)
• "Iguana": The Iguanaworks IR transceiver
Methods
• boolean Send(in DOMString Type, in unsigned long code)
• boolean SetSendPolarity(in boolean polarity)
Example
The following JavaScript example sends the indicated IR codes when the corresponding functions are
called:
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
13
BSVideoMode
For more information about available methods, please refer to the Object Reference Manual entry on
roVideoMode. If you’d like to change the video mode of the player, you will need to use BrightScript
instead of this JavaScript class.
Attributes
• readonly
• readonly
• readonly
• readonly
• readonly
• readonly
• readonly
attribute
attribute
attribute
attribute
attribute
attribute
attribute
int resX
int resY
int safeX
int safeY
int safeWidth
int safeHeight
DOMString mode
Methods
• boolean IsAttached(in DOMString connector)
• DOMString GetBestMode(in DOMString connector)
• boolean SetBackgroundColour(in unsigned long rgb)
• boolean SetBackgroundColour(in unsigned long r,
in unsigned long g,
in unsigned long b)
• boolean HdmiAudioDisable(in boolean disable)
Example
The following JavaScript example illustrates how to retrieve information about the current video
mode:
function fillInVideoData()
{
var videomode_info = new BSVideoMode();
document.getElementById("resX").innerHTML = videomode_info.resX;
document.getElementById("resY").innerHTML = videomode_info.resY;
document.getElementById("safeX").innerHTML = videomode_info.safeX;
document.getElementById("safeY").innerHTML = videomode_info.safeY;
document.getElementById("safeWidth").innerHTML =
videomode_info.safeWidth;
document.getElementById("safeHeight").innerHTML =
videomode_info.safeHeight;
document.getElementById("videoMode").innerHTML = videomode_info.mode;
document.getElementById("bestMode").innerHTML =
videomode_info.GetBestMode("hdmi");
document.getElementById("connectedFlag").innerHTML =
videomode_info.IsAttached("vga");
}
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
14
function changeBackground()
{
var videomode_info = new BSVideoMode();
videomode_info.SetBackgroundColour(0xFF0000);
}
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
15
BSCECTransmitter
For more information about available methods, refer to the Object Reference Manual entry on
roCecInterface. Note that you can only use this JavaScript class to send CEC messages.
Methods
• boolean SendRawMessage(in ArrayBuffer data)
• boolean SendRawMessage(in ArrayBufferView data)
• boolean SendRawMessage(in DOMString data)
Example
The following JavaScript example shows how to send a set of CEC messages:
function cecDisplayOn()
{
console.log("### cecDisplayOn ###");
var cec_control = new BSCECTransmitter();
var buffer = new Uint8Array(2);
buffer[ 0 ] = 0x40;
buffer[ 1 ] = 0x0D;
cec_control.SendRawMessage(buffer);
}
function cecDisplayOff()
{
console.log("### cecDisplayOff ###");
var cec_control = new BSCECTransmitter();
var buffer = new Uint8Array(2);
buffer[ 0 ] = 0x40;
buffer[ 1 ] = 0x36;
}
cec_control.SendRawMessage(buffer);
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
16
BSCECReceiver
For more information about available methods, refer to the Object Reference Manual entry for
roCecInterface. Note that you can only use this JavaScript class to receive CEC messages.
Events
The following events are available on the BSCECReceiver object. They can receive an event of the
type CECReceiverEvent.
• onececrxframe
• oncectxcomplete
CECReceiverEvent – Attributes
• readonly attribute int status
• readonly attribute DOMString data
Example
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
17
BSSyncManager
For more information about available methods, refer to the Object Reference Manual entry for
roSyncManager.
Object Creation
BSSyncManager(in DOMString domain, in DOMString multicast_address, in
DOMString multicast_port);
Methods
• BSSyncManager(in DOMString domain, in DOMString multicast_address,
in DOMString multicast_port)
• void SetMaster(in boolean master_mode) raises(DOMException)
• void Synchronize(in DOMString id, in unsigned long ms_delay)
raises(DOMException)
Events
The following event is available on the BSSyncManager object. It can receive events of the type
BSSyncManagerEvent.
• onsyncevent
HTML video tags have been extended to include a setSyncParams function. Calling this function
causes a video to synchronize with the specified sync group.
• setSyncParams(in DOMString domain, in DOMString id, in DOMString
iso_timestamp)
BSSyncManagerEvent – Attributes
The following attributes are relevant to the onsyncevent event:
• readonly attribute DOMString domain
• readonly attribute DOMString id
• readonly attribute DOMString iso_timestamp
Example
The following JavaScript example contains two videos being synchronized locally with
BSSyncManager. If a Slave player is configured to be in the same PTP domain as the Master player
and uses the Slave HTML script, then it will display the videos in sync with the Master player. This
can be implemented on multiple Slave players.
Master Script:
Technical Notes – JavaScript Objects (FW ver. 6.0.x)
18
Slave Script: