Partner Glossary

autorun brs upon bootup, players look for an autorun brs file which instructs the player what to do upon startup this file is required for all players autorun zip and autozip brs players also look for autorun zip files that contain the script autozip brs if found, the player will execute autozip brs which unpacks the contents of the autorun zip file to the root directory of the storage device and reboots the player brightsign author this software, available for mac and pc, provides an easy to use interface for creating presentations, create and assign player schedules, and monitor player status and health of players the software also enables users to setup, activate, and provision new players as well as manage user roles and permissions brightscript debug console the brightscript debug console is a tool that facilitates debugging of brightscript code it is available through the brightsign shell (see below) to turn the brightscript debug console on, type script debug on at the console more info can be found here docid\ ywksi6x 2hez1bwztfhmp brightsign shell / console the brightsign shell, also referred to as the brightsign console, is the command line interface that enables interaction with the brightsign os through a serial cable or telnet/ssh from the brightsign shell, the script command can be used to access the brightscript debug console, and the node command can be used to access node related functions commands for the brightsign shell can be found here docid\ fxxyu9jmocutc6xe2p7l2 bsn cloud brightsign’s robust cloud based platform that provides a myriad of tools and services to help customers and partners easily use a single player or manage an expansive network of players bsn cloud consists of four different options the free brightsign author and control and the paid brightsign author plus and content plus see the author docid 2nkigkjlqyb3uudxxecnc and control docid 5gqlisk9evu6kfhzqje38 pages for more information on these products chromium chromium is the free and open source web browser project primarily developed and maintained by google it is the underlying engine for the ubiquitous chrome browser brightsign players use the same chromium software to render and display web content console the informal name for brightsign’s command line interface cms as might be surmised, a content management system, or cms, is used to manage content cmss are also often used to manage player setup, activation, provisioning, scheduling, and diagnostics while separate apps may be used to author and publish presentations, this guide will use the term cms as a catch all term to refer to software that enables authoring, publishing, and management of presentations, content, and players content delivery this term is used to describe the process of getting content onto the player’s storage device content / presentation strictly speaking, a presentation refers to the file that controls the layout and behavior of the items that the player will display content refers to the visual item(s) being displayed by the presentation content thus refers to media files associated with the presentation such as videos, images, and audio files since the presentation and content depend on each other to render properly (one cannot be displayed without the other), the term “content” is generally be used to represent both the presentation and its content crash dumps when a player encounters a non deliberate shutdown (aka a crash), “crash dumps” are generated upon reboot these files contain useful information that brightsign support can analyze and use to help troubleshoot these files can be found in the brightsign dumps folder located in the root folder of the player’s storage device diagnostic web server the diagnostic web server (dws) is a powerful tool that enables inspection of various player settings and diagnostic details both a local diagnostic web server (ldws, accessible over the local network via the player’s ip address) and remote diagnostic web server (rdws, accessible via brightsign author) are available general info about the dws can be found here docid\ cecerj5wsfyr5diz3krnu and more specific info about the rdws can be found here docid 6zvebqjf7 9agt11u3eqw media analyzer the dws includes a useful tool that can analyze media files for playability more info can be found here docid 6zvebqjf7 9agt11u3eqw html html stands for hypertext markup language it is a standard markup language for web page creation and is also a common format for displaying presentations on brightsign players the html best practices docid\ gxctvnw8g46evdxookuku section will likely be very useful to developers specific sub sections from that document worth noting individually are listed below web inspector web pages can be debugged over the local network using the web inspector docid 4qlk1krr1cnx7xypwxry5 chromium version the chromium version that brightsign players use is likely several versions behind that version that most users are using in their web browsers find the chromium version for the specific firmware version of your player here docid\ ygi yiwt6pz2btu grfup during development and testing, it is useful to have the correct version of chromium on your mac or pc more information about this can be found here docid\ ygi yiwt6pz2btu grfup logs / diagnostics logs contain important diagnostic information about players system logs (sometimes referred to as player logs) from the player are available and can be gathered via a syslog server, telnet or ssh, or an rs 232 serial cable more info can be found here docid\ krrnujd7stbmmv3z3xjd3 refer to this article docid\ qsljgbc6ax5nzxhfnhtjw on obtaining player logs and this one docid\ molxn8l89xsedvjee4kmh for interpreting player logs logs can easily be accessed via the rdws as described here docid 6zvebqjf7 9agt11u3eqw node the node prompt is a command line interface (cli) that allows you to interact with node js it is used to run javascript code and execute node js commands partner app/cms a "partner cms", “partner application”, or “partner app” refers to the partner software that resides on the player’s storage device in most cases, it consists of the presentation that the partner wishes the player to display upon bootup, the player runs the autorun brs file which can be configured to invoke the partner app/cms player brightsign’s extensive line of hardware devices specifically designed for digital signage provisioning this term generally refers to the process of activating a player and getting an autorun brs file onto the player’s storage device registry the registry object allows you to read from and write to the player registry (the player’s persistent memory) more info about the registry can be found here docid\ txwoombd2 u12dfegx7ga serial ports brightsign players have serial ports for diagnostic purposes as well as to provide interactive capabilities more info about serial ports can be found here docid\ zen3qywtjohoeotkbrx2a setup file setup files contain information such as the intended publishing configuration and various player settings setup files can be applied to one or many players and different setup files can be saved to the setup library storage device brightsign players lack onboard storage and require a separate storage device storage devices include microsd (µsd) cards as well as usb drives such as thumb drives, external hard drives, and external solid state drives (ssds) many brightsign players also support internal ssds in the common m 2 form factor swivel while not an official term, the word “swivel” is sometimes used to describe a partner integration in which users interact with the partner’s cms using one browser tab while interacting with the brightsign control/author interface in another browser tab telnet and ssh telnet and ssh are both network protocols that allow you to connect to remote computers over the internet telnet is an older protocol that is used for remote access to servers and networking devices it sends data in plain text without any encryption or authentication, which makes it insecure ssh (secure shell) is a newer protocol that provides secure remote access to servers and networking devices it encrypts all data sent between the client and server, making it much more secure than telnet ssh also uses public key authentication for added security telnet and ssh can be used to communicate with brightsign players more info can be found here docid\ l0l gyihavtdbci9ffcqh visual studio code visual studio code (vs code) is a source code editor made by microsoft with the electron framework, for windows, linux and macos it is used for editing text and managing your entire codebase like an integrated development environment (ide) it supports debugging, syntax highlighting, intelligent code completion, snippets, code refactoring, and embedded git https //opensource com/article/20/6/open source alternatives vs code vs code extension for brightscript the popular brightscript language https //marketplace visualstudio com/items?itemname=rokucommunity brightscript extension for vscode https //code visualstudio com/ facilitates coding in brightscript and is used by thousands of developers around the world note that brightsign’s brightscript is a fork of roku’s brightscript the forks have diverged and while they are similar, they are technically not the same nevertheless, developers may find value in this extension