Page tree
Skip to end of metadata
Go to start of metadata

ON THIS PAGE

Note

The Device Setup feature is supported on Series 4 (XTx44 and XDx43) and Series 3 (XTx43, XDx33, HDx23, LS423) models only.

The Device Setup feature allows you to set up BrightSign players on-premise, without the need for any additional tools or software. To perform Device Setup on a player, you will need the following equipment:

  • A display with attached HDMI cable
  • A blank microSD card
  • A USB keyboard (and optional USB mouse) --or-- Ethernet cable connected to the local network

 

To perform Device Setup, follow these steps:

  1. Connect the display to the player.
  2. Insert the microSD card.
  3. Attach the USB keyboard (and optional mouse) or Ethernet cable.
  4. Power on the player.
  5. Wait a few moments. Then, follow the on-screen instructions.

Troubleshooting

If the Device Setup screen does not appear after a minute, try the following troubleshooting steps:

  • Ensure the microSD card does not contain an autorun.brs file. Players will always execute an autorun.brs file rather than running Device Setup.
  • Ensure you are using a Series 4 (XTx44 and XDx43) or Series 3 (XTx43, XDx33, HDx23, LS423, HO523) player. Earlier player models do not have the Device Setup feature.
  • Perform a factory reset on the player. If the player has already been set up (using BrightAuthor, BSN, or other means), then Device Setup will not run on the player unless it is reset to factory defaults.
  • Try another display and HDMI cable if you don't see anything on screen.

Introduction

When an un-configured player is powered on, the Introduction screen will display for 2 minutes: This will give you time to connect a USB keyboard (and optional USB mouse) to the player or access the player using a web browser. Accessing the player using one of these options will lock out the other option (i.e. you can't configure the player using both methods at the same time).

If the countdown timer reaches zero, the player will attempt automated provisioning over the network using B-Deploy or DHCP Option 43. Alternatively, if there are media files in the root directory of the microSD card, the player will begin automated, looping playback of the files when the countdown timer reaches zero.

  • Stop Timer: Click this button to pause the countdown timer. It cannot be restarted.
  • Next: Click this button to begin Device Setup.

Network Setup

This screen allows you to choose the network setup for the player:

  • EthernetConnects the player to a wired network. Choose this option if you plan to publish to the player using the BrightSign Network, Simple File Network, or Local File Network methods. You should also choose this option if you want to use remote assets (e.g. websites, MRSS feeds) in your presentations.
  • WiFiConnects the player to a wireless network. You must have a WiFi/Bluetooth module installed on the player to use this option. Choose this option if you plan to publish to the player using the BrightSign Network, Simple File Network, or Local File Network methods. You should also choose this option if you want to use remote assets (e.g. websites, MRSS feeds) in your presentations.
  • No NetworkingConfigures the player without networking. If you choose this configuration, the player will be set up as a Standalone device (i.e. you will publish content directly using an SD card or other storage device).
  • Play Media FilesPlays media files from the on-board storage (e.g. microSD card, USB drive) without further configuration.


Ethernet Settings

This screen allows you to configure your Ethernet connection. If the player is able to communicate with a DHCP server, it will automatically configure itself on the local network and list its IP parameters under Current Settings

If you wish to use the DHCP settings, you can click Use Current Settings without further configuration. If you wish to make changes to the automated configuration, or if the player is not able to contact a DHCP server, click Change Settings to configure the network settings manually.

Change Ethernet Settings

Use this screen to manually configure the network settings of the player:

  • IP Address:  Select one of the following:
    • Obtain an IP address automatically: The player will configure itself on the local network using DHCP. 
    • Use the following IP address: The IP settings of the player are configured manually.
  • ProxyCheck the Use proxy box to configure the player to communicate via a proxy server.
    • Address: Enter the address of the proxy. If you need to provide a user name and password for the proxy, use this format: <user name>:<password>@<proxy server address> (e.g. “admin:root@myproxy.com”).
    • Port: Enter the port number of the proxy.
  • Time Server: Check the Set Time Server box to change the server that the player will use to synchronize its clock. The BrightSign Network time server is used by default. 
    • URL: Enter the URL for the time server in this field.

When you are finished configuring the network settings, click Next – Network Diagnostics; the player will then attempt to connect to the network using these settings.

Wireless Setup

This screen allows you to connect to a wireless network:

  • SSID: Use the dropdown list to select a wireless network.
  • Security Key: Enter the password for the wireless network.

If you need to manually configure the player on the network, click the Advanced button to specify the player IP address, proxy server, hostname, etc. Otherwise, click the Next – Network Diagnostics button to connect to the wireless network immediately.

Advanced Wireless Setup

Use this screen to manually configure the wireless-network settings of the player:

  • IP Address: Select one of the following:
    • Obtain an IP address automatically: The player will configure itself on the wireless network using DHCP. 
    • Use the following IP address: The IP settings of the player are configured manually.
  • ProxyCheck the Use proxy box to configure the player to communicate via a proxy server.
    • Address: Enter the address of the proxy. If you need to provide a user name and password for the proxy, use this format: <user name>:<password>@<proxy server address> (e.g. “admin:root@myproxy.com”).
    • Port: Enter the port number of the proxy.
  • Time Server: Check the Set Time Server box to change the server that the player will use to synchronize its clock. The BrightSign Network time server is used by default. 
    • URL: Enter the URL for the time server in this field.

When you are finished configuring the wireless network settings, click Next – Network Diagnostics; the player will then attempt to connect to the wireless network using these settings.

Network Diagnostics

On this screen, the player will first test its connection to the wired/wireless network. If this test is successful, it will then attempt to connect to the Internet.

These tests can succeed, fail, or succeed partially with errors: Check the Show Details boxes to see more information about the tests results.

Publishing Options

Use this screen to select the publishing option for your player:

  • BrightSign Network: Use the BrightSign Network cloud-based content-management system (CMS) to remotely schedule presentations, distribute content, assign players to groups, and monitor the health of players.
  • Local File Networking: Publish presentations and schedules to players over your local network (using BrightAuthor).
  • Simple File Networking: Publish presentations and schedules remotely using your own web server.
  • Standalone: Publish presentations directly to your player using an SD card or USB drive. Use this method if your player doesn’t have a network connection or if you don't plan to update the presentation frequently.

BrightSign Network

Sign-In

Use this screen to sign in to the BrightSign Network:

  • Account: Enter the name of your BrightSign Network account.
  • User name: Enter your account user name (i.e. your Email address).
  • Password: Enter your account password.

Device Info

Use this screen to configure the player for the BrightSign Network:

  • Device Name: Enter a name for the player.
  • Customization: Select Append device serial to append the serial number of the player to the end of the player name. Select Use name only to not append anything to the player name.
  • Device Description:(Optional) Enter a description for the player. A description can help you remember the purpose or location of the player when publishing to it later.
  • Time Zone: Select the time zone where the player is located.
  • Firmware: Select a firmware update option:

    • Production Firmware: The current release version of firmware. This may be the same version as the current firmware on the player.

    • Current Firmware: The firmware version currently on the player (i.e. no firmware update)
    • Beta Firmware: The current beta version of firmware

    Note

    If you choose to update the firmware, the player will download the selected firmware version and apply it after completing the Device Setup process—this can take several minutes.

  • Group: Assign the player to a BrightSign Network group.

Click the Finish button to complete BrightSign Network setup, or click the Advanced button to configure additional networking options for the player.

Network & Server

Use this screen to configure BSN and local server settings:

  • Network: Configure the following settings:
    • Check content frequency: Specify how often the player should communicate with the BSN servers to determine if there is new scheduled content to download.
    • Update health frequency: Specify how often the player should send health status updates to the BSN servers.
    • Specify Host Name: Check this box to specify a hostname for the player.
  • Diagnostic Web Server: Check this box to enable the Diagnostic Web Server on the player. This will allow you to perform various system functions—such as rebooting the player, changing display settings, and retrieving log files—by accessing the player IP address from a web browser. You can include a Password if desired, while the username defaults to “admin”.
  • Local Web Server: Check this box to enable the Local Web Server on the player. This allows you to modify User Variables using a web browser or the BrightSign App. You may include a Username and Password in the text fields for added security.

Click the Next button to configure logging and Remote Snapshot settings, or click the Finish button to complete BrightSign Network setup.

Logging & Remote Snapshot

Use this screen to configure logging and Remote Snapshot settings:

  • Logging: Use the check boxes to enable/disable logs. You can view logs in the Current Usage tab of the BSN WebUI or in the currentLog folder on the player storage.
    • Playback: Records playback start and end times, zone names, media types, and file names.
    • State: Records timestamps, state names, zone names, event types, and event data.
    • Event: Records current and last state names, timestamps, and media types.
    • Diagnostic: Records timestamps, firmware and script versions, and the current presentation.
    • Uploads logs: Specify log upload settings:
      • On Startup: Check this box to have the player upload its logs to the BSN servers each time it boots up.
      • At specific time each day: Check this box to have the player upload its logs daily at the specified time.
  • Remote Snapshot: Check the Enable Remote Snapshot box to enable the Remote Snapshot feature, which allows you to remotely monitor the contents of the presentation display.
    • Capture Interval (minutes): Specify how often the player should take a snapshot of the presentation display.
    • JPEG Quality Level (1 - 100): Specify the quality level (and thus the file size) of each image file.
    • Number of Snapshots to Keep on Local Storage: Specify how many JPEG snapshot images can be stored on the local storage of the player.
    • Display snapshots in portrait mode: Check this box to have the player rotate snapshots to portrait mode before saving and uploading them.

Click the Finish button to complete BrightSign Network setup.

Local File Networking

Device Info

Use this screen to configure the player for Local File Networking:

  • Device Name: Enter a name for the player.
  • Customization: Select Append device serial to append the serial number of the player to the end of the player name. Select Use name only to not append anything to the player name.
  • Device Description:(Optional) Enter a description for the player. A description can help you remember the purpose or location of the player when publishing to it later.
  • Time Zone: Select the time zone where the player is located.
  • Firmware: Select a firmware update option:

    • Production Firmware: The current release version of firmware. This may be the same version as the current firmware on the player.

    • Current Firmware: The firmware version currently on the player (i.e. no firmware update)
    • Beta Firmware: The current beta version of firmware

    Note

    If you choose to update the firmware, the player will download the selected firmware version and apply it after completing the Device Setup process—this can take several minutes.

Click the Finish button to complete the setup process, or click the Advanced button to configure additional networking options for the player.

Network & Server

Use this screen to configure network and local server settings:

  • Network: Check the Specify Host Name box to specify a hostname for the player.
  • Diagnostic Web Server: Check this box to enable the Diagnostic Web Server on the player. This will allow you to perform various system functions—such as rebooting the player, changing display settings, and retrieving log files—by accessing the player IP address from a web browser. You can include a Password if desired, while the username defaults to “admin”.
  • Local Web Server: Check this box to enable the Local Web Server on the player. This allows you to modify User Variables using a web browser or the BrightSign App. You may include a Username and Password in the text fields for added security.

Click the Next button to configure logging and Remote Snapshot settings, or click the Finish button to complete the setup process.

Logging & Remote SNapshot

Use this screen to configure logging and Remote Snapshot settings:

  • Logging: Use the check boxes to enable/disable logs. You can retrieve the logs from the currentLog folder on the device storage.
    • Playback: Records playback start and end times, zone names, media types, and file names.
    • State: Records timestamps, state names, zone names, event types, and event data.
    • Event: Records current and last state names, timestamps, and media types.
    • Diagnostic: Records timestamps, firmware and script versions, and the current presentation.
  • Remote Snapshot: Check the Enable Remote Snapshot box to enable the Remote Snapshot feature, which allows you to remotely monitor the contents of the presentation display.
    • Capture Interval (minutes): Specify how often the player should take a snapshot of the presentation display.
    • JPEG Quality Level (1 - 100): Specify the quality level (and thus the file size) of each image file.
    • Number of Snapshots to Keep on Local Storage: Specify how many JPEG snapshot images can be stored on the local storage of the player.
    • Display snapshots in portrait mode: Check this box to have the player rotate snapshots to portrait mode before saving and uploading them.

Click the Finish button to complete the setup process.

Simple File Networking

Device Info

Use this screen to configure the player for Simple File Networking:

  • Device Name: Enter a name for the player.
  • Customization: Select Append device serial to append the serial number of the player to the end of the player name. Select Use name only to not append anything to the player name.
  • Device Description:(Optional) Enter a description for the player.
  • Time Zone: Select the time zone where the player is located.
  • Firmware: Select a firmware update option:

    • Production Firmware: The current release version of firmware. This may be the same version as the current firmware on the player.

    • Current Firmware: The firmware version currently on the player (i.e. no firmware update)
    • Beta Firmware: The current beta version of firmware

      Note

      If you choose to update the firmware, the player will download the selected firmware version and apply it after completing the Device Setup process—this can take several minutes.

  • URL for web folder: Specify the network/Internet location from which the device will download content updates. Do not use trailing slashes in your URL; some web servers do not support trailing slashes.

Click the Finish button to complete the setup process, or click the Advanced button to configure additional networking options for the player.

Network & Server

Use this screen to configure network and local server settings:

  • Network: Configure the following settings:
    • Content check frequency: Specify how often the device should check your server for updates.
    • Simple File Networking Configuration: Enter a User name and Password if you wish to enable digest authentication between the device and the server.
    • Enable Basic Authentication: Check this box to have the device pass credentials to the web server in unsecured packets. Use this option only if it is absolutely required by the configuration of your web server.
    • Specify Host Name: Check this box to specify a hostname for the player.
  • Diagnostic Web Server: Check this box to enable the Diagnostic Web Server on the player. This will allow you to perform various system functions—such as rebooting the player, changing display settings, and retrieving log files—by accessing the player IP address from a web browser. You can include a Password if desired, while the username defaults to “admin”.
  • Local Web Server: Check this box to enable the Local Web Server on the player. This allows you to modify User Variables using a web browser or the BrightSign App. You may include a Username and Password in the text fields for added security.

Click the Next button to configure logging and Remote Snapshot settings, or click the Finish button to complete the setup process.

Logging & Remote Snapshot

Use this screen to configure logging and Remote Snapshot settings:

  • Logging: Use the check boxes to enable/disable logs. You can retrieve the logs from the currentLog folder on the device storage.
    • Playback: Records playback start and end times, zone names, media types, and file names.
    • State: Records timestamps, state names, zone names, event types, and event data.
    • Event: Records current and last state names, timestamps, and media types.
    • Diagnostic: Records timestamps, firmware and script versions, and the current presentation.
  • Remote Snapshot: Check the Enable Remote Snapshot box to enable the Remote Snapshot feature, which allows you to remotely monitor the contents of the presentation display.
    • Capture Interval (minutes): Specify how often the player should take a snapshot of the presentation display.
    • JPEG Quality Level (1 - 100): Specify the quality level (and thus the file size) of each image file.
    • Number of Snapshots to Keep on Local Storage: Specify how many JPEG snapshot images can be stored on the local storage of the player.
    • Display snapshots in portrait mode: Check this box to have the player rotate snapshots to portrait mode before saving and uploading them.

Click the Finish button to complete the setup process.

Standalone

Device Info

Use this screen to configure the player for Simple File Networking:

  • Device Name: Enter a name for the player.
  • Customization: Select Append device serial to append the serial number of the player to the end of the player name. Select Use name only to not append anything to the player name.
  • Device Description:(Optional) Enter a description for the player.
  • Time Zone: Select the time zone where the player is located.
  • Firmware: Select a firmware update option:

    • Production Firmware: The current release version of firmware. This may be the same version as the current firmware on the player.

    • Current Firmware: The firmware version currently on the player (i.e. no firmware update)
    • Beta Firmware: The current beta version of firmware

      Note

      Firmware updates require a connection to the Internet. If you choose to update the firmware, the player will download the selected firmware version and apply it after completing the Device Setup process—this can take several minutes.

Click the Finish button to complete the setup process, or click the Advanced button to configure additional networking options for the player.

Network & Server

Use this screen to configure network and local server settings:

  • Network: Check the Specify Host Name box to specify a hostname for the player.
  • Diagnostic Web Server: Check this box to enable the Diagnostic Web Server on the player. This will allow you to perform various system functions—such as rebooting the player, changing display settings, and retrieving log files—by accessing the player IP address from a web browser. You can include a Password if desired, while the username defaults to “admin”.
  • Local Web Server: Check this box to enable the Local Web Server on the player. This allows you to modify User Variables using a web browser or the BrightSign App. You may include a Username and Password in the text fields for added security.

Click the Next button to configure logging and Remote Snapshot settings, or click the Finish button to complete the setup process.

Logging & Remote SNapshot

Use this screen to configure logging and Remote Snapshot settings:

  • Logging: Use the check boxes to enable/disable logs. You can retrieve the logs from the currentLog folder on the device storage.
    • Playback: Records playback start and end times, zone names, media types, and file names.
    • State: Records timestamps, state names, zone names, event types, and event data.
    • Event: Records current and last state names, timestamps, and media types.
    • Diagnostic: Records timestamps, firmware and script versions, and the current presentation.
  • Remote Snapshot: Check the Enable Remote Snapshot box to enable the Remote Snapshot feature, which allows you to remotely monitor the contents of the presentation display.
    • Capture Interval (minutes): Specify how often the player should take a snapshot of the presentation display.
    • JPEG Quality Level (1 - 100): Specify the quality level (and thus the file size) of each image file.
    • Number of Snapshots to Keep on Local Storage: Specify how many JPEG snapshot images can be stored on the local storage of the player.
    • Display snapshots in portrait mode: Check this box to have the player rotate snapshots to portrait mode before saving and uploading them.

Click the Finish button to complete the setup process.