If, while a script is running, a runtime error occurs or a STOP statement is encountered, the BrightSign application will enter the BrightScript debug console. The debug console can be accessed via the BrightSign application console, which communicates over the primary serial port by default and can be accessed from a terminal program using a null-modem cable. The BrightSign application console can alternatively be routed over Telnet or SSH.

You can also access the debug console at bootup:

  1. Power off the device. 
  2. Hold the SVC button and power on the device.
  3. Wait until the brightsign> prompt appears in the serial/Telnet/SSH terminal (which indicates that you are in the BrightSign Shell). You can now release the SVC button.
  4. Enter script at the prompt while in the BrightSign Shell. This will take you to the BrightScript debug console.

The above instructions apply to Series 4 (XTx44, XDx34, HDx24, LS424) and Series 3 (XTx43, XDx33, HDx23, LS423) players. To access the debug console on earlier player models, power on the device and wait at least 5 seconds after the power LED (pwr) lights up. Then, use a paperclip or pen to press and hold the SVC button on the side of the player until the brightsign> prompt appears in the terminal.

The console scope is set to the function that was running when a runtime error or STOP statement occurred. While in the console, you can type in any BrightScript statement; it will then be compiled and executed in the current context.

BrightScript Console Commands

The following console commands are currently available in the BrightScript debug console:



Print a backtrace of call-function context frames.


List all public classes.

cont or c

Continue script execution.


List count of BrightScript Component instances.


Show disassembly and bytecode for this function.

down or d

Move one position down the function context chain.


Exit the debug shell.


Run the garbage collector and show collection statistics.


Print the internal hash-table histograms.


Show the last line that executed.

methods <class>

List methods provided by specified class.

methods <class>.<interface>

List methods provided by the specified interface or class.


List the current source of the current function.


Show line data (source records)


Show the next line to execute.


List all allocated BrightScript Component instances.


Show statistics.

step or s

Step one program statement.


Step one statement and show each executed opcode.

up or u

Move one function up the context chain.


Display local variables and their types/values.

print or p or ?

Print variable value or expression.*

*BrightScript print messages are routed to the BrightSign application console, which is accessible via the primary serial port or Telnet/SSH, as noted above.

BrightSign Shell Commands

The following commands are currently available in the BrightSign Shell:

?Display the list of available commands.
helpProvide more information about a command.
clearClear the terminal window.
exitExit the shell.
dir <directory>List the contents of a storage directory.
readperfMeasure the performance of file reading.
writeperfMeasure the performance of file writing.
rwperfMeasure simultaneus file read/write performance.
audioplayPlay an audio snippet.
scriptStart the BrightScript debug console.
mfgPerform a manufacturing test.
psList tasks.
rebootReboot the system.
shutdownShut down the system.
dateDisplay the date and time.
date <YYYY/MM/DD hh:mm:ss>Set the date and time.
timezoneDisplay the time zone.
timezone listDisplay a list of accepted time zones.
timezone <zone>Set the time zone.
chdir <path> or cd <path>Change the current directory.
delete <filename>Delete files or or directories recursively.
versionDisplay software versions.
registryAccess the device registry.
uptimeDisplay device uptime.
writebootfileWrite a boot file to flash.
erasebootfileErase a boot file in flash.
idDisplay device identification information.
file <filename>Determine a file type.
hashCryptographically hash a file.
factoryresetReset the system to factory defaults.
format <drive> [<filesystem>] Format a drive using one of the following file systems: "vfat", "ext3", "ext4".
eject <drive>Eject a drive.
logDisplay the system log.
unsetrtcClear the real time clock (RTC). Note that this action does not modify the system clock.
probeProbe a file.
analyzeAnalyze a file.
ptpstatusDisplay the PTP status.
usblistDisplay a list of discovered USB devices.
ifconfigConfigure the network interface. Type help ifconfig for a full list of configuration options.
wifiscanScan for WiFi networks.
httpgetperf <url> [<destination_file>]Measure the download performance from the specified URL. If a destination file is not specified, the contents are discarded.
nslookupLook up the hostname in the DNS.
videoplayPlay a video snippet.
imageplayDisplay an image.
videomodeChange the current video mode.
edid hdmiRead the EDID from the attached monitor.
powersaveSet the VGA power saving mode.