BrightSign Registry Keys

registry key settings may be removed without notice see also roregistry docid\ ytpsfntswyfmxx8pcqjlf , roregistrysection docid\ ffm73tjd bthw4 p 0jvg (brightscript) registry docid\ txwoombd2 u12dfegx7ga (javascript) registry section registry key description key/value software that uses/writes this key audio volume defaults to “logarithmic”, but can be set to “linear” to make the audio volume curve act the same as series 4 and earlier players either linear or logarithmic boot splash controls whether the splash screen is shown if set to "0", the splash screen is not displayed, otherwise it is shown os brightscript debug enables/disables brightscript debugging (you can also enable this at the brightsign> prompt by typing "script debug on") "1" turns on brightscript debugging os customer obfuscation key allows you to use an alternative obfuscation key os html disable http cache some customers with web apps that make many xhr requests find that due to chromium's caching design many small files are created in the chromium cache directory, even when a storage quota is set this key will prevent that at the cost of a small performance reduction available from bos 8 5 62, 9 0 190, and 9 1 15 "1" disables http caching in chromium os html disable hw accelerated video decode disable support for hardware accelerated decode series 4 and older players do not support hardware accelerated decode "1" disables support for hw accelerated video decode in chromium when "use brightsign media player = 0" os html disable web security with bos 8 2 and later (chromium69 and later), several new cors checks have been added this lets you disable checks "1" disables checks this flag will take effect on all rohtmlwidget instances os html enable virtual keyboard enables the os built in virtual keyboard, which is an alternative to html virtual keyboard for simpler applications the os built in virtual keyboard has no customization options but it doesn’t require any script changes or plugins "1" enables the virtual keyboard html enable web inspector allows the rohtmlwidget web inspector to be enabled on bos 8 5 31 and newer, you must enable the inspector via this key and the rohtmlwidget config possible values are "1" or "0" written by the supervisor or customer, read by the os html js trace gc pass trace gc in js flags os html js trace fragmentation pass trace fragmentation in js flags os html js trace gc ignore scavenger pass trace gc ignore scavenfer in js flags os html js trace gc verbose pass trace gc verbose in js flags os html mse support enables mse support on series 3 players "1" turns on mse support on series 3 players series 4 players enable it by default when running bos 8 3+ it is ignored on series 5 players if the built in player is enabled os html mpm enable or disable the memory pressure monitor "1" enables mpm os html overlay scrollbar set scrollbar style "1" sets to touch friendly mode, otherwise as desktop os html process per tab set process per tab rather than process per site instance which is the default “1” sets process per tab rather than process per site instance (the default) os html tracecategories chromium trace control os html traceduration chromium trace capture time in seconds os html tracemaxsnapshots chromium trace maximum snapshots os html tracememorymaps enable memory bench marking "1" enables bench marking os html tracemonitorinterval chromium trace monitor interval in seconds must be > 30, or zero/missing to disable os html use brightsign media player disables mpv the chromium media player will be used instead and players will have hardware accelerated video decode inside html series 4 and earlier players do not support hardware accelerated decode "use brightsign media player = 0" disables mpv os html web inspector port allows the web inspector port to be changed from the default value of 2999 html webaudio support report web audio as enabled by default web audio support is incomplete; this option allows an appropriate report to be made depending on the application when present, this parameter must be "1" for web audio to be reported as enabled os html webgl antialiasing enabled enables webgl anti aliasing "1" enables webgl anti aliasing os html widget type changes the browser engine used for rohtmlwidget currently only valid for series 5 bos 9 0 126 to 9 0 145 1 allow electron or qtwebengine values in 9 0 145 1+, electron is deprecated and replaced with chromium110 , which sets the chromium version to chromium120 networking cdr a boolean value as to whether the content downloads should be restricted setup script and presentation autorun networking cdrl the length of time for the content download (this key and cdrs, below, create a window of time) setup script and presentation autorun networking cdrs the start time for the content download (this key and cdrl, above, create a window of time) setup script and presentation autorun networking curl debug turns on debug output whenever the os uses curl it can be very verbose and fill up logs quickly “1” turns on debug output whenever the os uses curl os networking dwse enables/disables the local dws “yes” enables, “no” disables the local dws supervisor, setup script networking ele a boolean value denoting if event logging should be enabled supervisor, setup script, presentation autorun networking enableremotesnapshot a boolean value denoting if remote snapshot is enabled setup script, presentation autorun networking force igmp version allows customization of the player response to the igmp network environment see igmp behavior docid\ p2 nlzkngns1e9ebk62yr networking http server lets you run the dws on the standard port see diagnostic web server (dws) docid\ xue20rjxhft lq0rdmjbw os and supervisor networking isc set the color for the splash screen setup script, presentation autorun networking ldws certs path available in bos 8 5 64 and higher, this key can be used to provide the folder path to certs, which can be in any storage folder location example values are /storage/ssd , /storage/usb , /storage/flash networking ple a boolean value denoting if playback logging should be enabled or not supervisor, setup script, presentation autorun networking prometheus node exporter port by default, node exporter binds to localhost 9100 only to enable metrics collection – this will happen if the key is unset or with any setting other than an explicit disable this setting is available in bos 9 0 144 and above " " explicitly disables node exporter if the value is set to an integer usable as a port number (1025 to 65535, with 9100 being the conventional port) , node exporter metrics will be available on all external interfaces on that port number port numbers < 1025 will prevent the binding of node exporter to external adapters and an error message will be logged however, the service will be bound to localhost 9100 supervisor, monitoring networking ptp domain ptp clocks are turned off by default, this command lets you turn them on to turn on ptp clocks (substitute the domain reserved ptp address number) registry write networking ptp domain <# between 0 127> reboot os networking rdwse a boolean flag which tells you if rdws is enabled or not a value of “true” means that the rdws is enabled this is the default value supervisor networking recurl url to which "/recovery ashx" is appended if the previous registry entry is not present if ''\[networking]recover'' or ''\[networking]ru'' keys exists then the recovery url is the contents of that registry key otherwise if ''\[networking]recurl'' exists, the recovery url is the contents of that registry key with ''"/recovery ashx"'' appended networking remotesnapshotinterval if remoteshapshot is enabled, use this to set the interval at which the remote snapshot should be taken setup script, presentation autorun networking remotesnapshotjpegqualitylevel if remoteshapshot is enabled, use this to set the quality level at which the remote snapshot should be taken the quality level is a number setup script, presentation autorun networking remotesnapshotmaximages if remoteshapshot is enabled, use this to set the maximum number of images that should be taken older images will be deleted setup script, presentation autorun networking remotesnapshotorientation if remoteshapshot is enabled, use this to set portrait or landscape orientation setup script, presentation autorun networking rollback enabled a boolean value indicating if the rollback feature should be enabled or not a value of “false” disables rollback (which is enabled by default) supervisor networking rs after the os calls the recovery handler, one of recovery reinstall noreformat bas and recovery reinstall bas will be returned this is used in both files as a url to download the recovery script recovery brightscript networking rtl8821 disable ht disables or enables ht on realtek wifi (ws103) this requires bos 8 1 70 or higher set this value to “1” to disable ht on realtek wifi (ws103); other values means enabled os networking rtl8821 disable vht disables or enables vht on realtek wifi (ws103) this requires bos 8 1 70 or higher set this value to “1” to disable vht on realtek wifi (ws103); other values mean enabled os networking ru a url used by system software to download a script to be executed in the event of recovery if this key exists, the recovery url is the contents of the key os networking serial with telnet enables serial over telnet by default, enabling brightsign level telnet or ssh will disable the serial console the first serial port can still be used by scripts for communication with other devices; it just stops being usable as a console but if kernel console output is enabled then that will still be visible on the first serial port a value of ''1'' enables serial console at the same time as telnet note that serial communication via roserialport in scripts will be highly unreliable to set the password ifconfig login password my top secret password os networking sip the static ip address for either the ethernet or wifi interface supervisor, setup script, presentation autorun networking sip2 the static ip address for either the ethernet or wifi interface (sip2 denotes the interface with the lower priority) supervisor, setup script, presentation autorun networking status handler duration the interval to report status supervisor networking ssh enables ssh access a reboot is required for this to take effect but do not do this until you have set a password! to enable ssh access, set the key to the ssh port (the default ssh port is 22) for example registry write networking ssh 22 to disable ssh access, delete the key (the player must reboot for this to take effect) for example registry delete networking ssh os networking subnetmask vlan '+id the subnet mask for the static configuration of the vlan interface id suffix refers to vlan id supervisor networking syslog configures remote logging see rosystemlog docid\ krrnujd7stbmmv3z3xjd3 os networking telnet enables or deletes telnet access to enable telnet access set this key to the port you wish to run telnet on (the default telnet port is 23) delete the key to disable telnet access os networking telnet server enables telnet access to the linux shell prompt on players that have had secure boot disabled or are booting without verification you can enable this feature along with brightsign level telnet if they run on different ports set this registry key to the port you wish to run telnet on for example registry write networking telnet server 23 os networking twf tells you if text feeds data type is enabled over the wifi interface a boolean value networking twr tells you if text feeds data type is enabled over the ethernet interface a boolean value networking/private tz the device time zone networking ub a url prefix which is applied to all urls that follow if they do not contain a colon this value is the url prefix to apply networking vu events are reported to this url os networking wifi indicates if wifi is enabled on the player or not a boolean value supervisor, setup script, presentation autorun networking wired debug enable verbose diagnostics on the ethernet interface os serial usb first ls3 and ls4 players don't have a dedicated serial port, but have several ways to send and receive serial data depending on the cable in use two types of cable can be used a "passive serial splitter" or a "genuine usb serial adapter", which can be set with this key “\[usb]type c serial” or “\[serial]usb first”, with the right port number, set the cable value to either "passive serial splitter" or a "genuine usb serial adapter" a “usb first” value only affects serial ports opened by brightscript and javascript, not the console os usb hotplug tty 106c 3718 1 0 supports pantech uml290 modems note that there is a generic "hotplug tty" mechanism, this is just an example the appended numbers are modem keys reflecting product id, vendor id, and interface number the settings numbers are visible in /sys/bus/usb/devices when the modem is plugged in os usb hotplug tty 12d1 155e 1 0 supports huawei e3531 / e3372 modems the appended numbers are modem keys reflecting product id, vendor id, and interface number the settings numbers are visible in /sys/bus/usb/devices when the modem is plugged in os usb type c serial ls3 and ls4 players don't have a dedicated serial port, but have several ways to send and receive serial data, depending on the cable in use this registry setting is only required when using a passive serial cable (like the ones that brightsign makes with a usb type a socket and a 3 5mm socket) and not when using a usb serial adapter the cable type "passive serial splitter" or a "genuine usb serial adapter" os video auto mode vms override overrides the “auto” video mode and allows multi output or other video modes to be configured for the player outside a cms app when a video mode is set to “auto”, or not specified by a script, the player should see if a specific mode is set in the public registry if it finds a valid video mode stored there, it should apply that instead of negotiating a mode using the edid provided by the sync video gpu sync available only in bos versions 9 0 168 to 9 0 189, this alleviates artifacts and/or frame corruption when content goes through the gpu it will affect hs5, ls5, mx5, hd5, and xd5 players, but is ignored on xt5, xc5, and series 4 players this setting comes with a performance hit setting the value to 1 enables a workaround artifacts and/or frame corruption when content goes through the gpu os