Configure Appspace App on BrightSign

This article provides instructions to configure and register BrightSign devices with the Appspace App, and other BrightSign specific configurations such as enable closed captioning, enable text overlay over video, configure BrightSign for 4k Displays etc.

We also provide instructions to manually update the Appspace App and BrightSign firmware, as the BrightSign devices do not auto-update.

Prerequisites

• The device must meet the manufacturer’s minimum hardware and technical specifications. Please refer to Supported Devices & Operating Systems.
  Important

  Appspace Support for BrightSign Series 5 Devices (XC5, XT5, XD5, HD5, LS5)

  While we support the entire Series 5 lineup, our comprehensive testing efforts have been primarily focused on the XC4055 model which we have supported along with BrightSignOS 9.0 since December of 2022.

  Appspace remains committed to ensuring the compatibility and functionality of our software across the entire BrightSign Series 5 range, encompassing the XC5, XT5, XD5, HD5, and LS5 models.

  Customers can confidently choose from any of the Series 5 models, knowing that Appspace support is available, even if we have not yet specifically certified every model.
  
  Note

  The BrightSign RC-1001 remote control is only supported via the 3.5mm IR jack on BrightSign devices, and not via the USB IR receivers.
• Ensure the device has been installed with the latest BrightSign firmware. Download here: https://www.brightsign.biz/downloads/overview.
• A BrightSign compatible SD card/USB drive/SSD storage device.
  Important

  BrightSign devices with SSD storage are only compatible with Appspace App 1.33 and above, and BrightSign firmware 7.0.60 and above is required.
• A USB keyboard for activation.
• An active Appspace account, with sufficient device licenses to register the device.
• Account Owner or Location Admin user roles with sufficient platform licenses.
• An active Internet connection.
  Note

  • To connect to a wireless network, ensure your BrightSign device is fitted with the WS103 wireless module. More info can be found on the BrightSign website: https://www.brightsign.biz/digital-signage-products/accessories/wifi-modules

  • To configure BrightSign to connect to a wireless network, follow the instructions here: http://docs.brightsign.biz/display/DOC/Device+Setup#DeviceSetup-WirelessSetup

  • To configure security certificates on to the BrightSign device, follow the instructions here: http://docs.brightsign.biz/display/DOC/BrightSign+Network+Setup#BrightSignNetworkSetup-Wired/Wireless

• It is recommended that the device clock is set to automatically retrieve time from a Network Time Protocol (NTP) server, with the correct time zone, in order for it to sync correctly with the Appspace server.
  Note

  • Appspace cloud servers by default retrieve time from a NTP server. If an Appspace on-premises server is used, ensure the server time is automatically retrieved by a NTP server.

  • Appspace has updated the timezone configurations, which now includes timezones other than GMT. This enables users with daylight savings to adjust the time accordingly.

    For more information, please refer to the Appspace 7.1-ac.8 Release Notes

• Please ensure your network is configured to allow Appspace Approved URLs and the relevant network ports.
  On your proxy server, ensure our approved URLs are listed in the ‘How to set up networks with SSL content filters’ section in the following article: https://support.google.com/chrome/a/answer/3504942#sslinspection.

Configure BrightSign with Appspace App

Follow the instructions below to setup the BrightSign device:

1. Log in to the Appspace console.
2. Select the ☰ Appspace menu, and click System > Downloads.
3. Download the Appspace App for BrightSign client file (autorun.zip).
   Important

   Do NOT extract the autorun.zip file.
4. Copy the autorun.zip file to an SSD storage, an SD card, or a USB drive according to your preference. If using an SD card or a USB drive, plug in the devices into the BrightSign device.
   Warning

   BrightSign devices with SSD storage are only compatible with Appspace App 1.33 and above, with BrightSign firmware 7.0.60 and above.
   
   
5. The Appspace App installation package will be automatically extracted to the storage device.
   Note

   The autorun.zip file is automatically deleted from the storage device after the extraction.
6. Connect the BrightSign device to a display screen.
7. Ensure network connectivity is active, and switch on the BrightSign device.
8. Wait for the device to boot-up and display the Device registration page.
   Note

   The BrightSign device may need to be restarted a couple of times if the device registration page does not show up.
9. Launch the Appspace App.
10. Register your device.

11. If using an SSD, once the initial installation and registration process is complete, you may remove the SD card or USB drive, as the Appspace App will operate solely from the SSD storage hereafter.

Enable Closed Captioning on BrightSign

To enable Closed Captioning or subtitles manually, follow the instructions below.

1. Log in to the Appspace console.
2. Select the ☰ Appspace menu, and select Channels.
3. Select the desired advanced channel, and select the Edit tab.
4. Click the edit button for the layout containing the Media Zone widget.
5. In the editing window, select the Media Zone widget, and click the Properties button.
6. Select the Properties tab, and click the Edit button.
7. Enter in the following widget property:

   Description	Widget Property	Value
   Closed Captioning / Subtitles	custom.media.video.cc	Boolean (True or False)

8. Once done, click Finish.
9. Select the Appearance tab, and ensure that Background Color is set to the default value of #000000 with the OPACITY of 0.
   You may also click the None button to return to the default value.
10. Click Apply, and close the window once changes have been made.
11. Back on the editing window, change the layout Background Color to #010203 with the OPACITY of 100, or edit the following widget property:
     
    

    Description	Widget Property	Value
    Change the background color to black	standard.bgcolor	#ff010203

    
    
12. Click Apply, and Save once done.

Enable Text Overlay over Video

To enable text overlay over video for viewing in interactive mode/channel browsing mode (user mode on a web browser or mobile device), add a device property, while to enable it on a sign channel, add a widget property to the Media Zone widget instead.

Enable Text Overlay over Video in Interactive Mode (Channel Browsing)

To enable text overlay over video in interactive mode on BrightSign devices during channel browsing, add the following device property:

Enable Text Overlay over Video in Advanced Channel (sign)

Follow the instructions below to enable text overlay over video in an advanced channel (sign):

1. Add the following property to your Media Zone widget:

   Description	Widget Property	Value
   Enable text overlay over video	Custom.media.video.layerindex	-1: Places the video behind all graphics
   		0: Disables “hwz” mode completely
   		1: Places the video in front of all graphics (the default setting)
   		2: Places the video in front of all graphics, as well as a second video element

   For instruction to add a widget property, please refer to Adding Widget Property.
   
   Note

   When “hwz” is enabled, the video is rendered as a video element, ensuring the highest possible frame rate and video quality. When “hwz” is disabled, the video is rendered as a graphics element.
2. Change the advanced channel’s layout Background Color to #010203, and set the Opacity slider value between 1 and 100 (non-zero value).

   Description	Widget Property	Value
   Change the background color to black	standard.bgcolor	#ff010203

   
   

Configure Device Rotation Settings 

Devices with Playlist Channels

In Appspace 7.0 and later, a single playlist channel automatically rotates based on the natural orientation of the device. However, BrightSign by default, does not have a device orientation setting to support this feature, and instead follows the current, or the last orientation setting of a device.

To play a single playlist channel in the desired orientation, set the device orientation in the BrightSign device settings, as per the following instructions:

1. Log in to the Appspace console.
2. Select the ☰ Appspace menu, and select Devices .
3. Select the desired BrightSign device, and click the Settings tab.
4. Select the desired Display orientation option.
   
5. Click Save.

Configure BrightSign for 4K Display

To display 4K content on BrightSign devices, you will need to modify the main.brs file before installing Appspace App onto the BrightSign device.

1. Log in to the Appspace console.
2. Select the ☰ Appspace menu, and click System > Downloads.
3. Download the Appspace App for BrightSign (autorun.zip) to your computer, and extract the autorun.zip file.
4. Navigate and open the main.brs file located in the appspace folder.
5. Locate the “vmCreate Object (“roVideoMode”) line of code, and enter the vm.SetMode(“4096x2160x30p:fullres:gfxmemlarge”) line of code below it.
   
   
   
   
   Code

   vm=CreateObject(“roVideoMode”)
   vm.SetMode(“4096x2160x30p:fullres:gfxmemlarge”)
   m.width=vm.GetResX()
   m.height=vm.GetResY()
6. Once done, save the main.brs file and repackage it back to the autorun.zip file.
7. Proceed to configure your BrightSign device with the modified autorun.zip file.

Configure BrightSign to Utilize Multiple HDMI Outputs (Video Wall)

To utilize the multiple HDMI outputs on BrightSign XC Series devices in a video wall configuration, you will need to modify the main.brs file before installing Appspace App onto the BrightSign device.

1. Log in to the Appspace console.
2. Select the ☰ Appspace menu, and click System > Downloads.
3. Download the Appspace App for BrightSign (autorun.zip) to your computer, and extract the autorun.zip file.
4. Navigate and open the main.brs file located in the appspace folder.
5. Locate the “vmCreate Object (“roVideoMode”) line of code (default in line 40), and enter the following block of code based on the video wall configuration and number of HDMI outputs that are utilized:
   Each Screen (HDMI Output) requires its own block of code to be added to the main.brs file. Example of the code block below: 
   
   

   sm.[x].video_mode - Resolution Setting
   sm.[x].transform - Rotation Setting
   sm.[x].display_x - Position of content on x axis (screen width)
   sm.[x].display_y - Position of content on y axis (screen height)
   sm.[x].enabled/disabled - Flag to power on/off this HDMI output.

   • Screens: To enable or disable a screen is merely a matter of setting sm[x].enabled or sm[x].disabled where ‘x‘ is the number of the HDMI output/screen.
   • Orientations: As you can see, its merely a matter of changing the sm[x].display_x or sm[x].display_y values depending on whether the wall is vertical or horizontal. You may need to take into account a bezel offset if perhaps the client screens are physically offset and they wish this effect to translate to the content.
   • Resolutions: The resolution values can be changed according to the supported resolutions guide from Brightsign. Review the Supported Video Modes article.
   • Rotations: To denote the proper screen rotation change the sm[x].transform value to either = { “normal”, “90”, “180”, “270” }.
6. Once done, save the main.brs file and repackage it back to the autorun.zip file.
7. Proceed to configure your BrightSign device with the modified autorun.zip file.

Example 1:

This code block example assumes a 2 x 1 video wall (1080p – “Horizontal Row” or a “standard wall”)

vm=CreateObject("roVideoMode")
sm = vm.GetScreenModes()

sm[0].video_mode="1920x1080x60p"
sm[0].transform = "normal"
sm[0].display_x=0
sm[0].display_y=0
sm[0].enabled=true

sm[1].video_mode="1920x1080x60p" 
sm[1].transform = "normal" 
sm[1].display_x=1920 'Not adding an offet for bezels, might need to increase this value if screen 2 is cutoff.
sm[1].display_y=0
sm[1].enabled=true

sm[2].enabled=false 'Disabling the other two screens just for testing
sm[3].enabled=false 'Disabling the other two screens just for testing

vm.SetScreenModes(sm)

Example 2:

This code block example assumes a 1 x 2 video wall (1080p – “Landscape Stack”)

vm=CreateObject("roVideoMode")
sm = vm.GetScreenModes()

sm[0].video_mode="1920x1080x60p"
sm[0].transform = "normal"
sm[0].display_x=0
sm[0].display_y=0
sm[0].enabled=true

sm[1].video_mode="1920x1080x60p"
sm[1].transform = "normal"
sm[1].display_x=0
sm[1].display_y=1100 ' Bezel compensation of 20 pixels
sm[1].enabled=true

sm[2].enabled=false
sm[3].enabled=false

vm.SetScreenModes(sm)

Update Appspace App on BrightSign

To ensure the Appspace App is updated on all supported BrightSign devices in the network, follow the instructions below:

Prerequisites

• Ensure the network allows devices to be updated.
  
  How To

  1. Navigate to Devices in the ☰ Appspace menu, and select the Locations > Properties tab.
  2. Ensure the Software.SoftwareUpdates device property value is set to TRUE.
• Ensure the BrightSign device is configured to receive updates automatically.
  
  How To

  1. Navigate to Devices in the ☰ Appspace menu.
  2. Select the desired BrightSign device, and click the Settings tab.
  3. Ensure the Software updates option is set to Automatic Update.

Update Appspace App

Follow the instructions below to manually update the Appspace App: 

1. Log in to the Appspace console.
2. Click the ☰ Appspace menu, and click to System > Downloads.
3. Download the latest Appspace App for BrightSign package, and save it to a hosted folder.
4. Click the ☰ Appspace menu, and then click Devices > Device Tasks.
5. Click the Advanced Tasks tab, and click the +ADD button.
6. Select the Appspace App : Brightsign App Updater task.
7. Configure the advanced task, and deploy it to the network where the BrightSign devices are registered.
   
8. Click Save.

Update BrightSign Firmware

Follow the instructions below to manually update the BrightSign firmware: 

1. Download the BrightSign firmware of your device from the BrightSign Downloads site at: https://www.brightsign.biz/downloads/overview
2. Extract the BrightSign firmware .zip file.
3. Copy only the .bsfw file and paste it in a folder on the local web server.
4. Right-click and compress the .bsfw file.
5. Log in to the Appspace console.
6. Select the ☰ Appspace menu, and navigate to Devices > Device Tasks.
7. Select the Advanced Tasks tab.
8. Click the Add button, and select the Appspace App : Device Firmware Update task.
   
9. In the Common Parameters section, enter in the URL to the BrightSign firmware package on your local web server (from Step 3 above).
   
10. In the Deploy To section, select the desired network to deploy the task to.
11. In the Schedule section, select the desired deployment option.

12. Click Save.

• The RSS Ticker animation stutters when displayed on BrightSign devices due to technical limitations, caused by iframe loading issues.

BrightSign 9.0

• Videos that have been configured to be displayed in Portrait on BrightSign 9.0 devices are being displayed in Landscape due to a bug. Appspace has already begun working on this, and a fix will be available in a future release.