...

This document serves as a guide for accessing the BrightSign Shell and BrightScript Debugger of BrightSign players. Both of these can be accessed via a physical serial connection or over the network via SSH or Telnet. For the physical serial connection, certain cables are recommended as described below. If you already have compatible cables, however, you can jump ahead to the BrightSign Shell or the BrightScript Debugger.

What is the BrightSign Shell?

...

From here, a blank screen in the terminal app should appear. If your session reported any errors, please refer to the Troubleshooting section. Refer to the BrightSign Shell section for accessing the BrightSign Shell.

...

1. Connect the aforementioned cable assembly from the player to your computer. The 3.5mm connector should be plugged into the player’s 3.5mm serial port and the USB connector plugged into the computer.

2. Once the cables are connected, open a terminal app to establish a connection.

   The player should be named along the lines of /dev/tty.usbserial on macOS or /dev/ttyUSB0 on Linux:

   Code Block
   ls /dev/tty.usb*

   The player can be found by running the following command:

   Code Block
   screen /dev/tty.usbserial 115200

   From here, a blank screen in the terminal app should appear. Note that the player’s name may be different depending on the type of computer and serial cable used. If your session reported any errors, please refer to the Troubleshooting section.

3. From here, we will enable the BrightSign Console.

   1. Power down the player.

      For the next few steps, pay close attention to the terminal app and watch the logs during the boot process. Specifically, watch for a message along the lines of “Press CTRL-C to stop automatic startup”.

   2. Press and hold down the SVC button while applying power to the player. This instructs the player to emit logs through the 3.5mm serial port.

   3. After ~3-5 seconds, the terminal app will ask you to press CTRL-C to stop automatic startup and will present a 3-second countdown. To stop automatic startup, press CTRL-C on your computer’s keyboard within the countdown window.

   4. Depending on the version of BrightSignOS installed on the player, you will see one of the following boot loader prompts: BOLT>, SECURE>, INSECURE> Enter the following at the boot loader prompt:

   Code Block
   console on reboot

   
   Example:

   Code Block
   SECURE> console on *** command status = 0 SECURE> reboot

...

Enable the BrightSign Shell through using a physical set of cables to establish a serial connection with the player. Refer to the BrightSign Shell section for information on the required cables and how to enable the BrightSign Shell.

...

Enable Telnet or SSH through BrightScript to establish a Telnet or SSH connection in order to access the logs. See the Telnet or SSH sections above for information on how to enable Telnet or SSH.

...

When enabled, the Local Diagnostic Web Server (Local DWS or LDWS) is a web server that runs on the BrightSign player. The Local DWS REST APIs expose access to the BrightSignOS and accessible via clients on the local network who have authenticated using Basic or Digest Authentication. The Local DWS can be used to access logs, network settings, display details, and connected peripherals. The logs can also be viewed or downloaded from the Local DWS.

See LDWS API Logs Endpoints for more information.

Logs from Remote Diagnostic Web Server APIs

When enabled, the Remote Diagnostic Web Server (Remote DWS or RDWS) is a web server that runs on the BrightSign player. The Remote DWS REST APIs expose access to the BrightSignOS and accessible via authorized requesting clients with a OAuth token. The logs can also be viewed or downloaded from the Remote DWS.

See Remote Diagnostic Web Server /logsDWS APIs for more information.

Debugging BrightScript Code

This section will cover how to debug BrightScript code on a BrightSign player assuming the BrightScript Debugger has been enabled and is accessible.

Refer to the BrightSign Shell and BrightScript Debugger sections for info on enabling and accessing the BrightSign Shell and BrightScript Debugger.

...

Verify the tty Profile is Correct

Refer to the Connecting Player to Computer section for establishing a serial connection between the player and your computer. If the profile is incorrect, the terminal app will not be able to connect to the player.

...

To persistently enable the Shell, at the boot loader prompt, type console on and then reboot.

More information found here.

The BrightSign Shell is Not Displaying

...

If these steps don’t work, the Shell may not be enabled. Please refer to the section about the BrightSign Shell to enable it.

Resetting your Mac Serial Terminal Connection

...