Overview
Device Setup allows you to set up a player for your desired publishing type and configure various other settings on the player.
You can create a Device Setup from the option within the Admin tab, Device Setup Library, or from the Schedule tab.
Device Settings
Package Name (1): Enter a name for the Device Setup. Once it has been saved, you can locate the name in the Device Setup Library if you use the Add Setup File to Library option.
Device Name (2): Enter a name for the player. All players provisioned with the Device Setup will use this name by default, though individual names can be specified when players are added to the Device Provisioning library.
Device Description(3): (Optional) Enter a description for the player.
Customization (4, 5, 6): Customize the device-naming scheme:
- Append Unit ID: Appends the serial number of the player to the end of the Device Name. This option is useful if you're applying the Device Setup to multiple players and want each player name to be unique.
- Use Name Only: Does not append anything to the Device Name.
- Time Zone: Select the time zone where the player is located.
- Idle Screen Color: Specify what screen color the player should display if it does not have an active presentation.
Device Type (7)
: Select a publishing method for the player. Anchor device_type device_type
- Standalone: Allows you to publish files that can be put on SD card or USB and then physically delivered to your player. Use this method if your player doesn't have a network connection and/or you do not plan to update the presentation frequently. You can use the USB drive to update the schedule/presentation if you don't want to remove the SD card and/or it is inaccessible. The USB drive can be used with or without a password: the password protection feature ensures that a player cannot be updated with the Publish for USB update option unless the correct password is supplied. If you choose to require a password, note that the password cannot be changed once configured, and cannot be recovered. See this page for more information.
- Simple File Networking: Publish presentations remotely using your own web server.
- URL for WebFolder: Specify the location from which the player will download content updates. Do not use trailing slashes in your URL; some web servers do not support trailing slashes. If you're having trouble getting players to communicate with your web server, see this FAQ for troubleshooting tips.
- Content Check Frequency: Set how often you want the player to check your server for updates.
- Simple File Networking Authentication (optional): Enter a User name and password to enable digest authentication between the BrightSign player and the server.
- Enable basic authentication: Instruct the player 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.
- Partner Application: Select custom applications created by BSN.cloud integrated partners.
- Custom Application URL: Specify an URL address to point players directly to an externally hosted application (for example, if your players are set up behind a firewall).
For more information on how to change device types, watch this tutorial video:
Widget Connector width 500 url https://vimeo.com/351440170 height 290
Network Configuration (8):
- Include Network Configuration allows you to set network options in the Network Options window.
- Use Current Device Settings if the player to be re-provisioned is currently configured on a network which requires a specification configuration (security, certificates, etc.) to maintain your player's current network configuration.
Save Setup Files (9): Publish the Device Setup manually. Follow these steps to complete the Device Setup process:
- Save the Device Setup files to an SD card (recommended) or USB flash drive. Ensure the setup files are saved to the root folder of the storage device.
- Turn off the BrightSign player by unplugging the power adapter (or Ethernet cable if the player is being powered by PoE).
- Insert the SD card or USB flash drive into the player.
Turn on the BrightSign player by reconnecting the power.
Note title Note We recommend formatting your SD/microSD card using FAT32 or exFAT. The exFAT format allows you to store files larger than 4GB, but is not supported on the 4Kx42.
Warning title Important The storage device must remain in the player at all times while playing presentations.
Add Setup File (10): Add the Device Setup to the BSN.cloud Device Setup Library. You can then open the Device Setup later or provision players using the Device Setup.
Network Options
Anchor | ||||
---|---|---|---|---|
|
Select Network Options to configure advanced network settings.
Player
- Specify hostname: Designate a custom hostname for the player on the local network. By default, the player serial number is used to generate a unique hostname (i.e. "brightsign-<serial_number>").
- Use Proxy: Configure the player to use 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. If you do not specify a port number, the player will default to using port 1080.
- Limit Content Downloads: Check this box to restrict player content downloads to a certain time of day. This is useful if you want to limit network traffic during peak hours.
- Start of Range: The beginning of the time frame during which content downloads can occur.
- End of Range: The end of the time frame during which content downloads can occur.
- Limit Health Updates: Check this box to restrict player health updates to a certain time of day. This is useful if you know that the player will be offline at certain times a day.
- Start of Range: The beginning of the time frame during which health updates can occur.
End of Range: The end of the time frame during which health updates can occur.
Note | ||
---|---|---|
| ||
BrightSign player health checks are reported at intervals of five minutes or more. |
Wired/Wireless
- Data Types Enabled: Use the checkboxes to determine the data types that can be transferred using the connection. You can enable/disable downloads (Content, Text Feeds, Media Feeds), as well as uploads (Health, Log Updates).
- Connection Settings: Specify how the player attains an IP address:
- Obtain an IP address automatically: The player obtains its IP address using DHCP.
- Use the following IP address: The player uses a static IP address. You will need to enter the required IP parameters in the fields.
- Rate Limit Network Download Traffic: Set rate limitations for downloading content. You can also set rate limitations for During content download window and During initial downloads.
- Unlimited Download Rate: Sets no limit on downloads.
- Default limit: Sets the default limit (2000 Kibit/s) on downloads.
- Specify limit: Sets a customized limit. Enter a limit in the text field (in Kbit/s).
Diagnostics
- Enable network diagnostics: Have the player display the Network Diagnostics screen during setup.
- Test Ethernet: The Network Diagnostics screen will indicate whether or not it was able to attain an IP address over Ethernet.
- Test Wireless: The Network Diagnostics screen will indicate whether or not it was able to attain an IP address over wireless.
- Test Internet Connection: The Network Diagnostics screen will indicate whether or not it was able to communicate with a remote server.
Advanced Device Settings
The Advanced Device Settings section on the right allows you to configure additional optional parameters.
Network Properties
- Time Server: Specify the server (using a supported protocol) that the player should use to synchronize its clock. Players use the BSN.cloud time server by default.
- Enable Wireless: Connect the player to the local network using a wireless connection. In order to use a wireless connection, you must purchase a Wireless Module for your BrightSign player.
- SSID: Enter the SSID of the wireless network.
- Security key: Enter the password for the wireless network
- Network Connection Priority: Choose to prioritize either the Wired or Wireless connection. The BrightSign player will always attempt to download and upload using the first option, and will only use the second option if the first is unavailable.
Device Configuration
- Enable Diagnostic Web Server: Enable the Diagnostic Web Server.
- Password: Specify a password for the server (the username is always "admin"). We strongly recommend securing the Diagnostic Web Server with a strong password.
Enable Local Web Server: Enable the Local Web Server, which is necessary for Local File Networking. This feature enables the Device Webpage, which allows you to update User Variables over the local network.
Tip title Tip You can access the Device Web Page using the BrightSign App or a web browser. To locate the Device Web Page on a web browser, enter the IP address of the player at port 8008 (for example, “10.0.1.199:8008”).
- User Name: Enter a user name for the Local Web Server login
- Password: Enter a password for the Local Web Server login
- Enable Update Notifications:(Optional) Check this box to have the player automatically refresh the Device Webpage whenever variable values change on the player.
Logging
Use the check boxes to enable/disable logs. Logs can be turned on and will work behind the scenes, but can only be retrieved from the SD card.
- Enable Playback Logging: Record playback start and end times, zone names, media types, and file names.
- Enable Event Logging: Record timestamps, state names, zone names, event types, and event data.
- Enable State Logging: Record current and last state names, timestamps, and media types.
- Enable Diagnostic Logging: Record timestamps, firmware and script versions, and the current presentation.
- Enable Variable Logging: Record the current and default values of all User Variables in the presentation.
- Uploads logs: This feature is available with SFN. 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.
BrightSign OS Update
Anchor | ||||
---|---|---|---|---|
|
Use this section to include an OS update file with the Device Setup. First, determine the behavior of the update file using the Update Type dropdown list:
- Standard: The OS update is applied to the player. The player reboots and deletes the update file after the update is complete.
- Different: The OS update is only applied if the version of the update file is different from the current OS version on the player. The player reboots and deletes the update file after the update is complete.
- Newer: The OS update is only applied if the version of the update file is newer than the current OS version on the player. If the player is booting up in Safe Mode, the update is always applied because the player cannot check its OS version before applying the update. The player reboots and deletes the update file after the update is complete.
- Save: The OS update is applied to the player, but the update file is not deleted from the storage device. The player does not reboot after applying the update; instead, it waits for the storage device containing the update file to be removed.
Next, select the version of the OS update file according to your player model:
- Production Release: The current official release of BrightSign OS
- Beta Release: The current beta release of BrightSign OS
- Minimum Compatible Release: The minimum OS version that supports presentations created by your version of BrightAuthor:connected. The minimum compatible OS may not support all features provided by a contemporary version of BrightAuthor:connected.
- Specific File: Select a .bsfw firmware update file from your hard drive. The other options will download the update file from BrightSign when the setup files are created.
- Update from URL: Enter the download URL for a .bsfw firmware update file. This option is only available when distributing a Device Setup via Device ProvisioningProvision.
Remote Snapshot
If you select the Enable Remote Snapshot checkbox, this feature will be enabled in BrightAuthor:connected with . Remote snapshots can be turned on and will work behind the scenes, but can only be retrieved from the SD card.
This feature has the following options:
- Remote Snapshot Interval: Specify how often the player should take a snapshot of the presentation display in minutes.
- Maximum Number of Images to Save: Specify how many JPEG snapshot images can be stored on the local storage of the player.
- JPEG Quality Level (1-100): Specify the quality level (and thus the file size) of each image file.
- Screen Orientation: Images can be rotated to either Landscape or Portrait mode.
- Relative URL for Remote Snapshot Handler: Post snapshots to this endpoint (only available for SFN).
Debugging
- Enable Serial Debugging: Enable serial debugging on the player. The autorun script will output debugging information related to the presentation to the serial port (as well as over Telnet and SSH if these features are enabled).
- Enable System Log Debugging: Enable system-log debugging on the player. The player will output system log information to the Log tab in the Diagnostic Web Server (or the serial/telnet/ssh ports if these are enabled via the Serial Debugging option).
Advanced
- Enable BSN.cloud: Enable the persistent Websockets connection between the player and BSN.cloud servers. This allows for BSN Control Cloud and Content Cloud functionality with players.
Warning | ||
---|---|---|
| ||
If you disable the Websockets connection, there is no way to enable it again remotely. You will need to perform Device Setup locally via a storage device to reenable this feature |