Diagnostic Web Server (DWS)

the diagnostic web server (dws) is a built in web service on all brightsign players it provides valuable info and functions, including key player info such as uptime, serial number, system logs, and real‑time screenshots of the display output diagnostic tools to troubleshoot issues the ability to modify some player settings and apply os updates important note regarding player settings in the dws when a player is registered to brightsign author or content, player settings are stored on brightsign cloud while the dws may enable temporary changes to player settings, brightsign cloud remains the ultimate "source of truth" and will override any local settings upon player reboots therefore you should modify player settings using the properties panel in brightsign author, brightsign content, or by using cloud apis, both of which will update the player settings in brightsign cloud this also applies to players registered with property lock docid\ a6ali6u szxhuansk6t3 explicitly disabled (by default, property lock is enabled) the above is only a partial list the dws' full capabilities are covered below local vs remote access the dws can be accessed in two ways l ocally , over the local network or via a serial connection remotely , over the internet through brightsign cloud (either the free brightsign control plus docid 6fdtqjwewi 2rn4hpudwa or the paid brightsign author plus docid 7sqjdlzkp5fqzdp4hnsxv ) while the dws offers substantially the same features whether accessed locally or remotely, some differences do exist as noted below note that traditionally, local access of the dws has been referred to as the local dws or ldws, and remote access of the dws has been referred to as the remote dws or rdws these terms may be used throughout the documentation local access to the dws is disabled by default as of brightsignos 9 0 218 (on the 9 0 branch) and brightsignos 9 1 75 (on the 9 1 branch) in brightsignos versions prior to these, local access to the dws was enabled by default note that some specially configured players have the external microsd card port and usb storage disabled at the factory (sku svc internal storage only) for these players, local access to the dws remains enabled by default for info on accessing the dws locally, see dws local access docid\ iafcherljfjdjtwttkpk5 for info on accessing the dws remotely, see dws remote access docid\ xue20rjxhft lq0rdmjbw the dws is organized by a horizontal row of tabs, each one with a different set of functions descriptions for each tab are detailed in the expandable sections below info this tab provides general information about the player and its current status time the current time as it is configured on the player when the dws is accessed locally, you can select the time icon (clock icon) to configure the time on the player automatically click use client to set the time of the player using the current time of the browser/application manually enter a time and date to set on the player these values will go into effect the moment you click the set time button if you would like to interpret the date/time using the time zone of the player, check the apply timezone box otherwise, the date/time will be applied as a utc value the player's time zone cannot be edited from the dws to change the time zone, you will need to apply a new setup docid\ xnnxywmv09iegziit7rwa to the player name the user supplied name of the player description an optional user supplied description for the player model the model number of the player unique id the serial number of the player network info ipv4 the ipv4 address of the player mac the mac (media access control) address of the player ipv6 the ipv6 address of the player boot version the current version of the primary boot loader brightsignos version the current os version installed on the player video mode the current video output resolution you can change the video resolution in the video tab uptime the amount of time the player has been powered on and working correctly power source displays the power source (e g , ac or poe) power over ethernet (poe) the status of the poe interface (applicable to poe capable models only) default state for local dws access local access (i e , access over the local network) of the diagnostic web server (dws) is disabled by default as of brightsignos 9 0 218 (on the 9 0 branch) and brightsignos 9 1 75 (on the 9 1 branch) in brightsignos versions prior to these, local access to the dws was enabled by default to enable local access to the dws, see dws local access docid\ iafcherljfjdjtwttkpk5 note that some specially configured players have the external microsd card port and usb storage disabled at the factory (sku svc internal storage only) for these players, local access to the dws remains enabled by default remote access (i e , access over the internet) of the dws remains available for all internet connected players registered with brightsign cloud the "default state" for local access of the dws can either be enabled or disabled here, a player's “default state” refers to when the player 1) is brand new from the factory or 2) when it has been factory reset importantly, this setting is only representative of the player’s default state; it is not necessarily representative of the player’s current state a player may have local access to the dws enabled (e g , through a setup file or a custom script) even though the player’s default state is for local dws access to be disabled this setting does not affect remote access of the dws remote access of the dws is always enabled if the player is registered on brightsign cloud extensions the info tab will include this field if the player has one or more extensions installed log this tab provides a log of system processes and events on the player the output is similar to the info generated through a serial connection download log download the current log refresh retrieve new log information from the player download crash dump retrieve information about the most recent crash on the player (if one has occurred); this is useful data for brightsign support when troubleshooting control this tab allows general control of the system processes of the player set password setting a password for the dws is only required when accessing the dws locally a password is not required for remote access of the dws as security is provided by brightsign cloud and brightsign author this option is only available when local access to the dws has been enabled set a new password for dws authentication on the local network the password must be at least eight characters long and include at least one uppercase letter, one lowercase letter, one number, and one special character reboot player reboot the player reboot with crash report reboot the player and save a crash report file to the "brightsign dumps" folder brightsign support may request the crash report when helping you troubleshoot the player factory reset perform a factory reset docid\ yncf7p2pyzo2qedf1jyim of the player this resets the player to its factory defaults, erasing all persistent registry settings for networking, security, and other applications in some cases, a player should be reprovisioned instead of factory reset see reprovision vs factory reset docid\ cyl9kpm02co5rgcb9wqqv recovery url set a recovery url which is used by the player to perform content recovery in the event of an autorun related failure reset ssh host keys ssh host keys establish trust between the player and ssh clients so that they can communicate with each other resetting the host keys may be desired when the host key is suspected to have been exposed or compromised multiple players share the same host keys (e g , a cloned microsd card was used across players), representing a potential security risk it is desired to reset the trust relationships with ssh clients this function resets the ssh host key and reboots the player the next time you connect to the player via ssh, you will be asked to re trust the new key reset default security certificates this function generates a new set of default security certificates (specifically, tls certificates that enable https access) and reboots the player when https is enabled for local dws access, and a specific server certificate is not specified (more info here docid 2zmel07w011h1267dt 59 ), default self signed certificates will be created when browsing to a player using default security certificates, users will need to accept browser security warnings and accept the certificate (more info here docid\ iafcherljfjdjtwttkpk5 ) this feature has no effect on configured custom certificates and only affects the default certificates default certificates have a 10 year expiration and are stored in a system partition and not on the storage device (e g , microsd card or ssd) reprovision player this feature is only available remotely as covered in the brightsign primer docid\ d1tz0hy4bh9ngcvuoe3of section, setting up a player for use involves applying a setup docid\ xnnxywmv09iegziit7rwa to the player, and applying a setup file to a player using brightsign cloud is known as provisioning applying a new setup file to a player which already has a setup file requires a process known as reprovisioning it is important to understand that from brightsign author's provision docid\ cyl9kpm02co5rgcb9wqqv screen, a new setup file can be applied to a player, a process which associates the player with the new setup file importantly, however, the new setup file will not actually take effect on the player until the player is explicitly reprovisioned (more details here docid\ cyl9kpm02co5rgcb9wqqv ) which is the function of this section of the dws the reprovision player function performs the following clears the player's storage device (e g , microsd card) deletes the player's registry settings note that the player's network settings are unaffected updates the player's setup file if the setup file includes new network settings, then those network settings will be incorporated reboots the player in addition to brightsign author or control, a new setup file can also be applied using the post and put api operations (see version 3 0 b deploy endpoints docid\ tckwb 5lqo95f6scssthi and version 2 0 b deploy endpoints docid dnq1coar6vi0o 1dpsm ) as with applying a setup file to a player using brightsign author, the player must be reprovisioned for the setup file to actually take effect sd / ssd / usb this tab provides information related to the storage device attached to the player the title of the tab will reflect the interface that the storage device is using to connect to the player for example, the sd tab will be displayed if a microsd card is attached to the player storage information select view to get more information about the player's storage device such as the health of the storage device, size of the storage device, percentage of storage used, etc storage encryption player storage device encryption is available for all series 5 players except the xc line (support coming soon) using brightsign author version 1 55 1 or later players must be running bos 9 0 211 or later the storage encryption state indicates whether encryption is enabled or disabled the available encryption methods are brightsign key this is a common key across all brightsign players unique key this is a randomly generated key that can only be used for this player on players with both internal and external sd slots (e g xd6, hd6), an sd card encrypted using this option will be linked to the sd slot it was encrypted in for example, an sd card encrypted in the internal sd card slot will error if you try to read it from the external sd card slot password this enables the setting of a custom password to be used as the encryption key storage encryption necessarily requires reformatting of the storage device which erases all content encrypting the storage device may result in the player losing its association with bright sign cloud you should therefore select automatically reprovision with bsn cloud to ensure that the player is able to successfully re associate with brightsign cloud after the encryption process upload files upload files to the player’s storage device (e g , microsd card) files are uploaded to the currently selected directory to upload files, click the browse button to select one or more files, then click upload files the maximum allowable size for files uploaded remotely is 10 mb aside from storage device capacity limits, there are no file size limitations for files uploaded locally download files this enables the download of the contents on the storage device (e g , microsd card) start download this creates a zip file of the storage device's contents cancel download this cancels the creation of the zip file download files this button is available once the zip file has been created it is grayed out otherwise after the zip file has been created, click this button to download the zip file to your computer note that after downloading the zip file, the zip file will no longer be available for download to download the storage device's contents again, the process must be initiated again by creating a new zip file listing provides a listing of all files on the storage device depending on the type of file, there will be several options open folder click a folder (indicated by the folder icon) to view its contents download click the download icon to download a file to your computer file downloads are limited to 10 mb on the remote dws file options click the gears icon to view more options associated with the file about \<filename> provides the file size and last modified date rename provides various options for renaming the file you can specify a custom name or choose from among a list of common filenames use caution if renaming a file to "autorun brs" the system does not check the integrity of the new autorun file analyze media file performs media analysis of a video or audio file delete click the trashcan icon to delete the file from the storage device diagnostics this tab provides various network and system tools that are helpful for diagnosing problems and getting information about a player network configuration view extensive info about network interface settings such as interface names, ip address, dns servers, etc network diagnostics run network diagnostics to check all ethernet, wi fi, modem, and internet connections this process may take some time to complete, especially when certain tests fail dns lookup test the specified dns address to check whether name resolution is working ping ping a device with the specified ip address or dns name trace route perform a standard traceroute diagnostic on the specified ip/dns address check the resolve ip addresses box to resolve the specified dns name chromium debugging this feature lets you enable the javascript console if you have also selected enable javascript console in brightsign author ( presentation > state properties > options ) to disable the javascript console, uncheck the checkbox the console should only be enabled for presentations that are not in production, since it can cause memory and security issues if you are not using brightsign author, the javascript console can be enabled through apis via rohtmlwidget docid\ xljq5 yhdma2ssmpzimtk or htmlwidget docid\ pmpuh3a0vr8ohjopsjwo7 network neighborhood display info about all players residing on the same local network network packet capture allows for the capture and collection of live network packet data over the network interfaces connected to the player disable autorun force the player to reboot and disable the autorun script when the player restarts this allows the player to display the os version and ip address on screen (if the player is connected to a local network) if the player has a serial port, you will be able to access the brightsign shell over a null modem serial cable storage formatting this t akes you to the format storage page, which allows you to format storage devices attached to the player storage devices that are currently unformatted can be directly formatted from here if the storage device already contains an autorun file, the autorun must first be disabled using the disable autorun function described above before proceeding with formatting of the storage device storage select a storage device from the drop down menu ( sd , ssd , or usb ) file system select a supported file system docid\ mgdefc6yvkibeiuxh9j1o to use when formatting the storage device ssh telnet access to players is no longer available in the diagnostic web server (dws) docid\ qxt4yhey7iej m9dh73wm as of brightsign author 1 67 0, brightsignos 9 0 218 (on the 9 0 branch), and brightsignos 9 1 70 (on the 9 1 branch) telnet can still be enabled via brightscript or javascript for more details on telnet, see enable telnet & ssh docid\ l0l gyihavtdbci9ffcqh authorized public keys can be provided for ssh public key authentication can be mixed with password authentication to disable password authentication do not set a login password enables ssh on the player which lets you access the brightsign application console when the serial port (the default i/o for the application console) is inaccessible for security reasons, enabling ssh in a production environment is not recommended ssh access is available in most os versions and can be enabled by using a custom script or by writing the registry key registry write networking ssh 22 enabling ssh via the dws, however, is only available in brightsignos 9 0 110 or 8 5 46 and above enable ssh enter the ssh port number (22 is the default) ssh password enter the ssh password the password must be at least 8 characters long and include at least one uppercase letter, one lowercase letter, one number, and one special character screenshots (snapshots) this tab allows you to view screenshots of what the player is displaying click the new screenshot button to take a screenshot once the screenshot has been taken, you can click the thumbnail to view a full size image of the screenshot as of brightsignos 8 5 31, screenshots are captured at resolution with a maximum size of hd select return the screenshot at its original resolution (do not downscale to hd) to get the screenshot at a higher resolution video this tab provides several diagnostic tools related to the player's video settings hdmi status whether each player's hdmi® connection (indicated as hdmi 1, hdmi 2, etc ) is “active” or “inactive” current video mode this is the video resolution currently being output on the hdmi connection if the player has multiple hdmi connections, each hdmi connection will be numbered (e g , hdmi 1, hdmi 2, etc ) if the player is set to a 4k video mode, this field will also indicate whether the 10 bit color space and/or hdr (high dynamic range) is currently being output power save disables hdmi output, the syncs for vga output, and/or the dac output for component video for each hdmi connection (indicated as hdmi 1, hdmi 2, etc ) the absence of a signal will cause some monitors to go into standby mode edid information displays the edid data returned from one or more monitors attached to the player’s hdmi ports (indicated as hdmi 1, hdmi 2, etc ) this info can be copied and pasted into a text editor change video mode changes the display mode / resolution of the player on all video outputs (hdmi®, vga, and component) the player will reboot and automatically disable the current autorun script (similar to the disable autorun button in the diagnostics tab) it the autorun script is not disabled, the autorun script will reset the video mode of the player it is important to note that this behavior applies to both brightsign author presentations as well as custom applications if the dws is used to temporarily change the player's video mode, you will need to reboot the player once again to return it the player the video mode set in its presentation or custom application advanced this tab includes the options below brightsignos update specific brightsignos versions are required for each player model/family if you attempt to update your player's os with an os for a different player model, you will get an error select one of the update options described below, and then select update to download that version to your player, which will then reboot production os the latest production brightsignos release for your player model beta os the latest beta version of the brightsignos for your player model minimum os the minimum brightsignos version that can run on your player custom url provide a player accessible url containing the desired brightsignos version, hosted by either you or brightsign example https //brightsignnetwork com/download/anon/firmware/cobra 9 0 110 update bsfw https //brightsignnetwork com/download/fturhan/firmware/cobra 9 0 110 update bsfw storage location by default, the dws will display tabs for all active external storage devices (e g , sd, ssd, usb) in addition, you can also temporarily view and access the player's internal storage enter the desired internal storage location (e g , flash, tmp) and select view a tab for the specified internal storage will be created this tab is temporary and will only be displayed for the current dws session; subsequent dws sessions will not automatically show this tab note that if you enter a storage device that is already listed, you will get an error in the example above, entering sd will result in an error because the sd tab is already being displayed brightsignos logs select the level of detail you prefer in the brightsignos logs and then select set to apply that setting the highest logging level will be included when lower logging levels are selected (for example, if you select info , error and warn loggings will be included as well) these are the logging levels error critical errors or failures in the application warn warnings about potential issues that are not critical but may require attention info informational messages about the application's normal operations this is the default logging level trace detailed tracing information, typically used for debugging property lock allows you to decide if your presentation settings should be overwritten or not for more info on property lock, see here docid\ a6ali6u szxhuansk6t3 registry this tab allows you to view and edit the player's registry select view registry dump to view the player registry you can copy the output to the clipboard or download it to a text file to submit registry commands, add registry entries, or delete registry entries, enter that information in the empty field under command and then select submit you must reboot the player to see changes to the registry this page describes the dws for brightsignos 8 and later refer to the pdf below for documentation on the dws prior to brightsignos 8