Setup
12 min
as covered in the brightsign primer docid\ d1tz0hy4bh9ngcvuoe3of section, when configuring a brightsign player for use, the player must have a “setup” applied the setup contains information such as the intended publishing mode as well as various player settings many of the brightsign author capabilities for player management are also accessible in brightsign control default setup when a player is provisioned and a setup is not explicitly applied to it, the default setup will be applied to the player the default setup can be one of two brightsign default setups or it can be a custom one brightsign default setup see default setup file section in the set up tab for more information about default setups brightsign cloud while brightsign author does offer limited functionality without a brightsign cloud account, accessing the full functionality of brightsign author requires that users be logged in to brightsign cloud launch brightsign author sign in (upper right corner) using your email address and password or click new user to create an account player settings you can configure various player settings in the setup screen a setup file can be created from the option within the admin tab ( admin > setup ) or via the setup library docid\ hzy2w0meeeryiforz9xfr image 20241218 175520 png image 20241218 182714 png setup name enter a name for the setup file if you wish to create this setup file to function as a default setup as described above, name the setup file “default setup” (spelling and capitalization as shown, no quotes) player name enter a name for the player all players provisioned with this setup file will use this name by default to differentiate between players, the name can be appended with a unique suffix per the customization section below player description enter an optional description for the player customization append player id appends the serial number of the player to the end of the player name this option is useful if you're applying the setup file to multiple players and want each player name to be unique use name only does not append anything to the player 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 the default is black, but you should choose a color other than black to differentiate when the screen is on or off publishing mode this section specifies the publishing mode the player will use see this page docid\ resciigy djrpuzgwaa4e to better understand these modes standalone this mode involves publishing your presentation to a storage device (such as a microsd card or usb drive) and then manually inserting the storage device into the player this method is suitable if your player doesn't have a network connection and/or you do not plan to update the presentation frequently the usb drive can be used to update the schedule/presentation if you do not want to remove the microsd 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 usb drive passwords docid\ ziqn3faw3e5pjyxjdll v for more information local network this mode publishes presentations to players over the local network players set up for local network require the local web server to be enabled which can be done via the player configuration part of the player settings bsn content (brightsign author plus) this mode (which will soon be renamed to brightsign author plus), publishes to players via brightsign cloud it requires a subscription and enables you to remotely schedule and publish presentations group select a brightsign cloud group for the player the player will appear in this group after the setup file has been applied and can later be moved to other groups if desired all players in a group receive the same presentation schedule groups can be added via the network docid\ uba8sfkmsajsibrbv4a6n tab web folder with this publishing mode, presentations/content are placed on a web folder accessible via a url a player set up for the web folder publishing mode periodically checks the url for new content and if new content is found, the player downloads the content from the url url for web folder specify the url from which the player will download content updates the use of trailing slashes in the url is not recommended as some web servers do not support trailing slashes if you're having trouble getting players to communicate with your web server, see web folder troubleshooting docid\ wleaappyqa 4lemrn0e2z for troubleshooting tips content check frequency set how often you want the player to check the web folder for updates web folder authentication (optional) enter a user name and password to enable authentication between the player and the server enable basic authentication instruct the player to 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 app/partner cms select applications created by brightsign cloud integrated partners see partner setup and recovery docid\ qt5mkqouwvlbscuzp9cc4 for more information about creating a recovery url for partner applications app url/cms url specify a url address to point players directly to an externally hosted application cms url is the current name for this method network configuration include network configuration allows you to set network options in the network options docid\ gfqm5hvphjqijhzxb2ngy window before connecting to your network use current player 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 publish the setup file manually follow these steps to complete the setup process save the setup file to a storage device (e g , microsd card or usb flash drive) ensure the setup file is saved to the root folder of the storage device turn off the player by unplugging the power adapter (or unplug the ethernet cable if the player is being powered by poe) insert the microsd card or usb flash drive into the player format the microsd card using fat32 or exfat the exfat format allows you to store files larger than 4gb, but is not supported on the 4kx42 the storage device must remain in the player at all times while playing presentations turn on the player by reconnecting the power players cannot be migrated from one brightsign cloud network to another unless the player provisioning record is first deleted from the old network and created in the new network (see provision docid\ cyl9kpm02co5rgcb9wqqv for more information) otherwise, the player will remain in the old network add setup to library add the setup file to the setup library docid\ hzy2w0meeeryiforz9xfr you can then open the setup later or provision players docid\ cyl9kpm02co5rgcb9wqqv using the setup file for more info on how to change player types, here is a tutorial video the player settings section on the right allows you to configure additional optional parameters player configuration enable diagnostic web server enable the diagnostic web server (dws) docid\ qxt4yhey7iej m9dh73wm and specify a password for the server (the username is always "admin") you should secure the dws with a strong password use default password use the player serial number as the password specify password the password will be reset to the password you input disable password no password is required enable local web server enable the local web server, which is necessary for local network configured players this feature enables the player web page, which allows you to update variables docid\ a6ali6u szxhuansk6t3 over the local network username a username for the local web server login password a password for the local web server login enable update notifications (optional) check this box to have the player automatically refresh the player web page whenever variable values change on the player you can access the player web page using brightsign author or a web browser to locate the player web page on a web browser, enter the ip address of the player at port 8008 (for example, “10 0 1 199 8008”) logs 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 microsd card playback record playback start and end times, zone names, media types, and file names events record timestamps, state names, zone names, event types, and event data states record current and last state names, timestamps, and media types diagnostics record timestamps, os, and script versions, and the current presentation variables record the current and default values of all variables docid\ a6ali6u szxhuansk6t3 in the presentation uploads this feature is available with the bsn content (brightsign author plus) and web folder publishing modes specify log upload settings on startup check this box to have the player upload its logs to brightsign cloud each time it boots up at specific time daily check this box to have the player upload its logs daily at the specified time relative url for log uploads if you are using web folder publishing, check this box to have the player upload logs to this url location brightsignos update use this section to include an os update file with the 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 rescue mode (safe mode / secure boot) docid\ yurogagj103wwxgodfmfj , 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 brightsignos beta release the current beta release of brightsignos minimum compatible release the minimum os version that supports presentations created by your version of brightsign author the minimum compatible os may not support all features provided by a contemporary version of brightsign author 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 setup file via player provisioning docid\ cyl9kpm02co5rgcb9wqqv remote screenshot if you select the enable remote screenshot checkbox, this feature will be enabled in brightsign author remote screenshots 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 screenshot interval specify how often the player should take a screenshot of the presentation display in minutes maximum number of images to save specify how many jpeg screenshot 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 landscape or portrait mode relative url for remote screenshot handler post screenshots to this endpoint (only available for the web folder publishing mode) 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 enable telnet & ssh docid\ l0l gyihavtdbci9ffcqh 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 docid\ xue20rjxhft lq0rdmjbw (or the serial/telnet/ssh ports if these are enabled via the serial debugging option) advanced enable bsn control or bsn content enable the persistent websockets connection between the player and brightsign cloud servers this allows players to access brightsign author or brightsign author plus if you disable the websockets connection, there is no way to enable it again remotely you will need to perform player set up locally via a storage device to reenable this feature pdf version