Developer Tools

brightsign offers an extensive array of developer tools these are listed here in alphabetical order brightsign shell & brightscript debugger the brightsign shell is the cli (command line interface) that enables interaction with the brightsignos through a serial cable or telnet/ssh the brightscript debugger is a tool that facilitates debugging of brightscript code more info about these tools can be found brightsign shell docid\ fxxyu9jmocutc6xe2p7l2 crash dumps if 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 for troubleshooting 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 or by typing http //brightsign nnnnnnnnnn local into a browser where nnnnnnnnnn is the serial number) and remote diagnostic web server (rdws, accessible via either the bsn control or bsn content at bsn cloud) are available general info about the dws can be found diagnostic web server (dws) docid\ qxt4yhey7iej m9dh73wm media analyzer the dws includes a useful tool that can analyze media files for playability more info can be found diagnostic web server (dws) docid\ qxt4yhey7iej m9dh73wm html html is a common format for displaying presentations on brightsign players the html best practices docid\ gxctvnw8g46evdxookuku page 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 debugging webpages 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 os version of your player chromium downloads docid\ ygi yiwt6pz2btu grfup during development and testing, it is useful to have the correct version of chromium on your mac or pc more info about this can be found chromium downloads 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 a serial cable more info about accessing logs via these means can be found brightsign shell docid\ fxxyu9jmocutc6xe2p7l2 refer to get player/dws logs docid\ qsljgbc6ax5nzxhfnhtjw on obtaining player logs and interpret player logs docid\ molxn8l89xsedvjee4kmh for interpreting player logs logs can easily be accessed via the rdws as described diagnostic web server (dws) docid\ qxt4yhey7iej m9dh73wm 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 information about the node prompt as well as the node inspector/debugger can be found debugging webpages docid 4qlk1krr1cnx7xypwxry5 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 registry docid\ txwoombd2 u12dfegx7ga serial ports brightsign players have serial ports for diagnostic purposes as well as to provide interactive capabilities more info about the hardware details of player serial ports can be found serial port configuration docid\ zen3qywtjohoeotkbrx2a and how to use the serial port to access the brightsign shell and brightscript debugger can be found brightsign shell docid\ fxxyu9jmocutc6xe2p7l2 telnet and ssh telnet and ssh can be used to communicate with brightsign players more info can be found brightsign shell docid\ fxxyu9jmocutc6xe2p7l2 vscode extension for brightscript the popular brightscript language extension https //marketplace visualstudio com/items?itemname=rokucommunity brightscript for vscode https //code visualstudio com/ facilitates writing 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 the value add is mainly the brightscript syntax highlighting next, we provide a recommended developer setup to help maximize efficiency in developing for the brightsign platform developer setup docid 92luy00tkntquk2z1siwf