CloudControl for BrightSign

As an integrator, you have the option to use our Cloud Control Device Management on your devices allowing you to perform actions and control your devices remotely. If you are unfamiliar with Device Management from signageOS information can be found here using an example from the Android platform.

There are several components necessary to get your application up and running alongside sOS CloudControl.

Requirements

1. Your own application compatible with BrightSign players
   1. Application has to contain Autorun.brs file
2. signageOS CC snippet
   1. Available for download in .zip format - Here (https://cc.signageos.io/brightsign)
3. Account in Box - organization UID
   1. You will need to provide the organization UID during the process - for more information on organizations and where to find the UID you can follow - Organisation

There are 2 options to choose from:

A) BrightScript Setup Option

- Suitable for any BrightSign application

B) HTML5 Setup Option

- Best for HTML5-driven applications, allows for dynamic initialization

A) BrightScript Setup Option

In this section, individual setup process is described to get your device functional with CloudControl Device Management.

Step 1

Upload your application to a storage medium. For BrightSign this should usually be a micro SD Card. Your application should contain a file autorun.brs as described before and required by any BrightSign application.

Step 2

Once all your files are in place, download the signageOS CC snippet available from Requirements Step 2.1 in this article. Unzip the file and you should be left with a folder "signageOS".

Step 3

Copy the unzipped signageOS folder into the Root folder without modifications.

Step 4

In your Autorun.brs file add the following library link on the first line:

LIBRARY "signageos/snippet.brs"

Step 5

In the same file (autorun.brs) as your first line in Sub Main() function add the following function with your organisation as string parameter:

signageOS_StartManagement("ORGANISATION_UID_HERE_AS_STRING")

Step 6

Save all your changes, plug in your modified SD Card/Memory medium, and boot up your player.

The device should boot and report itself in your organization available to be remotely managed via CloudControl functions/power actions/schedules etc. You can find your device in your Box console. Follow this link for more information about signageOS Box.

B) HTML5 Setup Option

If you have roHTMLObject in your BrightSign application as a main renderer/engine for your content (e.g.: you play via HTML5 and the browser is "always on"), you can implement the snippet via javascript.

1. Copy signageos folder into the root of your application

2. Add the following code to your index.html (adjust the src based on the location of the index.html)

    <script type="text/javascript" language="javascript" src="signageos/snippet.js"></script>

3. Check the mandatory roHTML5object configuration in your bright script (e.g.: in your autorun.brs):

{
  brightsign_js_objects_enabled: true,
  nodejs_enabled: true,
  javascript_enabled: true,
  security_params: {
    websecurity: false
  }
}

4. Initiate the snippet

As organizationUid fill in Organization UID from Box.

 htmlWidget.PostJSMessage({
        type: "ready",
        organization_uid: organizationUid
    })

Important note - Limitations

Below is a list of current limitations in certain functions and telemetry information. Limitations will be swiftly addressed with upcoming releases.

Info Tab & Power actions
Status	Functional
Application Version report	Functional
Network info & Debug	Functional
Power actions	Limited - Functional (Display ON/OFF, Reboot)
Screenshots tab
Screenshots	Functional
Settings tab
Brightness & Volume	Not functional
Timezone setting	Not functional
Native timer	Limited - Not functional
Proprietary timer	Functional
Scheduled reboot	Functional
Uptime
Online/Offline status	Functional
History tab
Commands history	Functional

In the newly released version, you might still see components in Box showing some of this information. The values populating these components can be ignored until future versions where unsupported features will be hidden.