Last updated on October 11, 2018

Installing the Appspace App on BrightSign

This article provides the instructions to configure and register BrightSign devices for Appspace.

Important

  • BrightSign devices are unable to update the Appspace App versions automatically. Please refer to the Update Appspace App on BrightSign section below for workarounds.
  • DHCP Option 43 is now supported on Appspace App 1.36 and above.

Prerequisites

  • The device must meet the manufacturer’s minimum hardware and technical specifications, as well as the Appspace App’s minimum requirements. Please refer to Appspace App requirements.

  • Ensure the device has been installed with the latest firmware (v 6.1.76 or higher). 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 is required.

  • An active Appspace account, with sufficient Device IDs to register the device.

  • 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

  • A USB keyboard for activation.

  • 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.

  • Ensure your network/firewall/anti-virus software is configured to allow access to the following:

    • Network port 80 (HTTP)
    • Network port 443 (HTTPS)

Note

If you need to reset the device to the default factory settings, please
refer to the vendor’s Support forum here: http://support.brightsign.biz/entries/21796878-How-do-I-restore-reset-a-unit-to-Factory-Default-settings-

Configure BrightSign

Follow the instructions below to setup the BrightSign device:

  1. Click System > Downloads from the Appspace Menu navigation bar, and download the Appspace App for BrightSign client (autorun.zip).

  2. Copy the autorun.zip file to a SSD storage, SD card or a USB drive according to your preference. If using SD card or 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, and BrightSign firmware 7.0.60 is required.

  3. 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.

  4. Connect the BrightSign device to a display screen.

  5. Ensure network connectivity is active, and switch on the BrightSign device. 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.

  6. Launch the Appspace App.

  7. Register your device.

  8. 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.


Configure BrightSign with Local Policy File

  1. Login to Appspace Cloud at cloud.appspace.com, and launch the device registration page via one of the following methods:

    • Click the Quick Actions menu and select Register a Device.
    • Go to the Device Registration widget on the Dashboard.
    • Click the Appspace menu, select Devices, and click the Add button in the Devices tab.


  2. In the Register a New Device window, click the advance device registration link


  3. In the Configure Advanced Registration window, select BrightSign Package for the Deployment Method drop-down menu.


  4. Select the network the device is in, and assign a channel for the device.

    Additionally you can configure fields such as DHCP, NTP server, Timezone, and Proxy Server. You can also perform custom scripting in the Script Configuration section.

    Optionally, clicking the Show advanced options allows you to configure the Device Description, Device Group and Device tags for the device.

  5. Click Download Autorun.zip to download the autorun.zip file.

  6. Save the autorun.zip file to a SSD storage, SD card or a USB drive according to your preference. If using SD card or 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, and BrightSign firmware 7.0.60 is required.

  7. 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.

  8. Connect the BrightSign device to a display screen.

  9. Ensure network connectivity is active, and switch on the BrightSign device.

  10. Wait for the BrightSign device to boot-up. The Appspace App will begin registering the device, and the selected channel will be displayed.

  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.


Using DHCP Option 43 provisioning for BrightSign

Typically, we download and store the autorun.zip file that contains a policy file on a SSD or SD card and manually register each device. If you have DHCP Option 43 enabled on your network, you can now leverage this option to allow all devices plugged in to the network, to auto-register the devices and begin playing the assigned channels, without user intervention via a provisioning script.


Prerequisites

  • A DHCP server on the local network configured with DHCP Option 43.

  • A provisioning server to handle the recovery request from the device.

  • A provisioning script that will download the autorun.zip file and reboot the device.

    Note

    For help configuring the above scripts and server, please contact BrightSign.


Follow the instructions below to setup the device for automatic registration with DHCP Option 43:

  1. Follow steps 1-4 in the Configure BrightSign with Local Policy File section above to configure the policy file.

  2. Click Download to download the autorun.zip file.

  3. Place the autorun.zip file on any desired web server.

  4. Define the URL path to the autorun.zip file in your provisioning script.

  5. Connect the BrightSign device to a display screen.

  6. Ensure network connectivity is active, and switch on the BrightSign device. Once the device boots-up, the device will automatically install, and register the Appspace App.

    Note

    The BrightSign device will restart a couple of times to complete this process.

  7. If you did not select a channel during the policy file configuration in step 1 above, you may:


Update Appspace App on BrightSign

Note

This is applicable to Appspace App version 1.13 and above.

To ensure the Appspace App is automatically updated on all supported BrightSign devices, follow the instructions below to update your Appspace App.

  1. Navigate to Admin > Networks, and set the Software.SoftwareUpdates player property value to TRUE. For instructions on how to add these player properties in the Appspace console, please refer to Managing device properties article.

  2. Navigate to System > Downloads in your Appspace Cloud account, and download the latest Appspace App for BrightSign package, and save it to a hosted folder.

  3. Navigate to Admin > Device Tasks in the Appspace menu.

  4. Select the Advanced Tasks tab, and add the Appspace App : Brightsign App Updater task.

  5. Configure the task and deploy to your desired network where the BrightSign devices are registered.


  6. Click Save.


Update BrightSign firmware via Device Tasks

  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. On the Appspace console, navigate to Admin > Device Tasks, and click the Advanced Tasks tab.

  6. Click the Add button, and select the Appspace App : Device Firmware Update task.


  7. In the Common Parameters section, enter in the URL to the BrightSign firmware package on your local web server (from Step 3 above).


  8. In the Deploy To section, select the desired network to deploy the task to.

  9. In the Schedule section, select the desired deployment option.

  10. Click Save.


Enable Text Overlay over Video

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

Please see instructions below.

Enable Text Overlay over Video in interactive mode

To enable text overlay over video in Interactive mode on BrightSign devices, you must add the following device property:

  • Custom.media.video.layerindex

    Value Range:

    • -2: Places the video behind all graphics, as well as a second video element.
    • -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.

    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.

    For instruction to add a device property, please refer to Adding New Device Properties.


Enable Text Overlay over Video in an advanced channel (sign)

  1. To enable text overlay over video in a sign on BrightSign devices, you must add the following property to your Media Zone widget:

    • Custom.media.video.layerindex

      Value Range:

      • -2: Places the video behind all graphics, as well as a second video element.
      • -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.

      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.

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


  2. Change the Sign channel layout Background Color to #010203.



Configure Device Rotation Settings

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

Thus to play a single playlist channel in the desired orientation, you must set the device orientation with the following device property: Display.Rotation

  • To display in Landscape, configure the Display.Rotation with a value of 0.

  • To display in Portrait, configure the Display.Rotation with a value of 90.


For instruction to add a device property, please refer to Adding New Device Properties.