User Guide HD110, HD210, HD410, HD810, HD1010, and HD2000 MATCHES: • BrightSign HD110, HD210, HD410, HD810, HD1010 Software Version: 3.0.
Copyright Copyright © 2008–2009 by BrightSign, a division of Roku, Inc. All rights reserved. Roku, the Roku logo, and the BrightSign logo are trademarks of Roku, Inc. Other brand and product names are trademarks or registered trademarks of their respective holders.
Contents •••••• Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 What is BrightSign? ....................................................... Sample BrightSign setups ................................................. Video or slide show loop .............................................. Interactive presentation .............................................. Examples .................................................
Chapter 4 Working with Playlists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 What is a playlist? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Creating a playlist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Playlist commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 6 Working with Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 What are scripts? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Sample script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Roku Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Referencing CF/SD cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Testing CF/SD cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Testing scripts, playlists, and interactive playlists . . . . . . . . . . . . . . . . . . . . . 93 Linux shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1 Introduction •••••• What is BrightSign? BrightSign is a standalone digital sign or kiosk controller that plays content from standard Flash memory cards. You can use BrightSign with almost any standard or high-definition monitor or TV to play continuous video or image loops.
Sample BrightSign setups You can connect BrightSign to a wide-range of devices based on your audio, video, and interactivity needs. Video or slide show loop Place a video or set of still images on a Secure Digital (SD) or CompactFlash (CF) card, and connect BrightSign to a display. (CF cards are supported on the HD2000 only.
Interactive presentation By connecting powered speakers to BrightSign, you can add audio to your display, and you can add interactivity by connecting an input device such as a keyboard, touch screen, button board, or LED. The example below uses an off-the-shelf USB keyboard.
Examples Here are some examples of what you can do with BrightSign: • • • • • Display a looping video with DVD+ quality on a variety of monitor types Display a looping video with HD quality on a variety of display types Display a looping slide show in high definition Play looping music Display videos and images simultaneously in different parts of the screen (also referred to as zones)—videos in one zone, slideshow in a second zone, and on the HD210, HD1010 and HD2000, an RSS feed in a third zone • (HD210
Chapter 2 Getting Started •••••• Step 1: Get the hardware you need To start using your BrightSign, you need the following hardware: Display Any monitor, TV, or Elo touch screen with one of the following types of inputs: • VGA • Component (HD810, HD1010, and HD2000 only) • HDMI Storage card Either of the following: • CF card (HD2000 only.
• GPIO (General Purpose Input/Output) button board (HD410, HD810, HD1010, and HD2000 only) • SoundBridge Remote • Null modem cable Step 2: Get the latest BrightSign software Depending on when you purchased your BrightSign, you may need to download and install the latest software from the BrightSign web site. TIP: Watch the BrightSign web site for information on BrightSign software updates so that you can take advantage of all the latest features. 1 Check your current software version.
Extract the software update file onto your SD card. (The file name is UPDATE.ROK.) 4 Insert the SD card into your BrightSign and apply power. • HD2000: Wait for your BrightSign to boot. (The display will be blank, but the LEDs on the front panel light as the unit boots.) Wait for the red upgrade LED to light up. During the upgrade, the connector activity LEDs turn on and off to indicate that the upgrade is in progress. • HD110, HD210, HD410, HD810, and HD1010: Wait for your BrightSign to boot.
5 Turn on the power. 6 Use the touch screen, mouse, or button board to select one of the four hot spots. You can also use the demo to try BrightSign with different types of monitors: Connect your BrightSign to a monitor or TV using a VGA, component, or HDMI connection. 2 Make sure your monitor is configured to receive input from the cable you’re using. 3 Start the demo by inserting the SD card you created in the previous set of steps.
Chapter 3 Playing Media with BrightSign •••••• Ways to play media There are several ways to play media files on a BrightSign device: • Play media automatically from an SD card when you turn on a BrightSign • Play media via a script on an SD card • Use the serial shell commands to test media playback NOTE: BrightSign HD110, HD210, HD410, HD810, and HD1010 output video through the VGA and HDMI connectors.
BrightSign can autoplay the following types of media: • MPEG-2 video. You can use a single file as a loop, or multiple files. On the HD2000, MPEG-2 files must be program streams. On the HD110, HD210, HD410, HD810, and HD1010, files must be transport streams with MP3 audio. • MP3 audio. Any MP3 audio (in a video or mp3 file) must have a sample rate of 48 kHz or 44.1 kHz (or 32 kHz on an HD110, HD210, HD410, HD810, or HD1010). • (HD2000 only) AC3, WMA, WAV, 5.1 Dolby digital audio.
Setting the video mode The BrightSign software automatically sets the video resolution by communicating with the display attached to your BrightSign. On the HD110, HD210, HD410, HD810, and HD1010, first BrightSign checks to see if a VGA display is attached. If it finds a VGA display, it sets the video resolution to the best mode supported by the VGA display and by BrightSign. If BrightSign doesn’t find a VGA display, it looks for an HDMI display.
Auto-playing files in alphabetical order upon power-up You can autoplay one or more files on power-up or reset. When you use this method, the files play in alphabetic order by file name. Copy your files into the root directory of an SD card. See the list of supported file types on the previous page. 2 Insert the SD card into your BrightSign. 3 Turn on your BrightSign. After a few moments, BrightSign plays the video and repeats it automatically to create a loop.
Auto-playing a playlist upon power-up A playlist is a text file that describes the items you want to play and the order in which you want to play them. A playlist can include still images, video clips, or audio clips. For details on creating playlists, see Working with Playlists. To autoplay a playlist file on power-up or reset, do the following: 1 2 3 4 5 Create a playlist file and name it AUTOPLAY.BSP (see Working with Playlists for details).
Auto-playing an interactive playlist upon power-up BrightSign HD410, HD810, HD1010, and HD2000 can also play a sophisticated presentation that is described in an interactive playlist. An interactive playlist is a simple text file that contains a table of information. Using Microsoft Excel, you can easily create a file that describes a sophisticated interactive presentation.
Auto-playing a script upon power-up Creating a BrightScript script gives you the most control over your interactive presentation. To autorun a script, do the following: Create a script using a text editor and name the file AUTORUN.BRS (see Working with Scripts for details). 2 Copy the script into the root directory of your SD card. 3 Insert the SD card into your BrightSign. 4 Turn on your BrightSign. After a few moments, BrightSign runs the script and plays the media referenced in the script.
Auto-playing content at a scheduled time (HD210, HD810, HD1010, and HD2000 only) To play videos, still images, playlists, or interactive playlists at scheduled times, do the following: 1 2 3 4 5 Create a scheduling file using a text editor and name the file AUTOSCHEDULE.TXT (see Scheduling playback (HD210, HD810, HD1010, and HD2000 only) for details). Copy AUTOSCHEDULE.TXT into the root directory of your SD card.
Chapter 4 Working with Playlists •••••• What is a playlist? A BrightSign playlist is a text file that ends in BSP (BrightSign Playlist). It contains the names of the files you want to play and the order in which you want to play them. Files in a playlist are played in sequence, one after the next. This means that you cannot use a playlist to play files simultaneously. For example, you cannot play an audio file and a video file at the same time unless you add your audio to your video file.
The files in a playlist don’t have to be bitmaps; you can use video or audio files too. You can also mix media types in a single playlist and trigger GPIO (General Purpose Input/Output) pins. In addition to filenames, there is a set of commands that you can use in a BrightSign playlist. For example, if you want the playlist to pause for 5 seconds between images, the slideshow playlist above could be modified like this: slideinterval 5 slide1.bmp slide2.bmp slide3.
Creating a playlist Using a text editor, such as Notepad, enter the names of the files you want to play in the order in which you want them to play. 2 (Optional) Enter any commands you want to add to your playlist. See the next section, Playlist commands, for a description of available commands. 3 Use the Save As command to the file with a BSP extension.
Playlist commands Here is the list of commands that you can use in a playlist: BMP, MP3, MPG (HD2000 only), VOB (HD2000 only), TS (HD110, HD210, HD410, HD810, and HD1010), PNG, JPG Any line that is a file name and that ends in one of these extensions is valid. Names may contain spaces. debug Use this command to view debug information on the display (serial port). rem Any line starting with rem is ignored, so you can include comments in your playlist. Rem is short for remark.
• • • • 1: Outputs USB audio. 2: Outputs SPDIF audio in stereo PCM. 3: Outputs SPDIF audio in raw AC3. 4: Outputs analog audio with SPDIF mirroring raw AC3. (HD2000 only) audiochan # (default is 2) Since there are three analog outputs, you must also use the audiochan command if you selected analog audio output: • audiochan 2: Sets output 1 (this is not a typo). • audiochan 1: Sets output 2. • audiochan 0: Sets output 3.
HD110, HD210, HD410, HD810, and HD1010: • VGA: • 1024x768x75p • 1360x768x60p • Component: • 720x576x50p • 720x480x60p • 1280x720x60p • 1280x720x50p • 1280x720x59.94p • 1920x1080x50i • 1920x1080x59.94i • 1920x1080x60i • HDMI: • 1024x768x75p • 1360x768x60p • 720x576x50p • 720x480x60p • 1280x720x60p • 1280x720x50p • 1280x720x59.94p • 1920x1080x50i • 1920x1080x59.94i • 1920x1080x60i • 1920x1080x50p • 1920x1080x29.
Viewmode (default is 0) You can use a view mode that is different from the default by setting the mode prior to starting video playback. The view_mode values are: • 0: Scales the video to fill the screen without maintaining the aspect ratio. Images may appear stretched. • 1: Centers the image and adds black borders. This is also referred to as letter boxed video. The aspect ratio is maintained. • 2: Centers the image and fills the screen. The aspect ratio is maintained.
• 14: Fades the image to the background color. • 15: Fades between the current image and the new image. • 16 to 19: Slides the image from top, bottom, left, and right. GPIOEnableInput (HD410, HD810, and HD1010 only) Sets the specified GPIO port as an input port. GPIOEnableOutput (HD410, HD810, and HD1010 only) Sets the specified GPIO port as an output port. GPIOOn , ,… Turns on the specified GPIO outputs. All other GPIO output ports are turned off.
lighton # or lightoff # Use the lighton and lightoff commands to set or clear one of the GPIO outputs. • For the HD410, HD810, and HD1010, the number can be any integer between 0 and 7. For example: lighton 3 sets LED 3 on the button board. • For the HD2000, the number can be any integer between 17 and 22. For example: lighton 17 sets LED 0 on the button board. waitbuttonany (HD410, HD810, HD1010, and HD2000 only) Use this command when you want the playlist to pause until any GPIO buttons is pressed.
Creating interactive presentations (HD410, HD810, HD1010, and HD2000 only) With BrightSign you can create presentations that respond to input from the user (capabilities vary by model, see Product Specifications for details on features supported by your model.) For example, you can let customers choose which video to watch by pressing the button associated with the video of their choice.
5 Use the Save As… command to keep your changes and select CSV as the file format. NOTE: BrightSign requires a comma-separated CSV file. If you’re outside the United States, check the regional settings in Excel and make sure the list separator is a comma and the decimal separator is a period. BrightSign requires a comma-separated CSV file with periods as the decimal separator (international defaults may vary). Below is a section of the AUTOPLAY.CSV file from the BrightSign demo.
Keywords You can include any of the following keywords at the beginning of your playlist file: VIDEOMODE HD2000: • 1024x768x60p • 1280x768x60p HD210, HD410, HD810, and HD1010: • • • • • • • • • • • • • 1024x768x75p 1360x768x60p 720x576x50p 720x480x60p 1280x720x60p 1280x720x50p 1280x720x59.94p 1920x1080x50i 1920x1080x59.94i 1920x1080x60i 1920x1080x50p 1920x1080x29.97p (preferred mode) 1920x1080x60p NOTE: The front panel button is not supported on the HD2000.
IMAGEMODE • 0: Centers the image and no scaling takes place. If the image is bigger than the screen, BrightSign crops the image. • 1: Scales the image to fit so that it is fully viewable with its aspect ratio maintained. • 2: Scales and crops the image so that it totally fills the screen with its aspect ratio maintained. • 3: Scales the image so that it fills the screen and the whole image is viewable. This means that the image is stretched and the aspect ratio may not be maintained.
VIDEOPLAYERAUDIOVOLUME (HD2000 only) Sets the volume when playing a video. The volume parameter can be any number between 0 and 100. AUDIOPLAYERAUDIOOUTPUT
FLIPELO (HD810, HD1010, and HD2000 only) Reverses the coordinates of the touch screen. This keyword isn’t used in the example above, and it should be used only if the touch screen coordinates appear to be reversed. FLIPELO IMAGEMODE 2 EVENTS elo:110:180:355:210 GPIOEnableInput (HD410, HD810, and HD1010 only) Sets the specified GPIO port as an input port. GPIOEnableOutput (HD410, HD810, and HD1010 only) Sets the specified GPIO port as an output port.
UDPReceiverPort (HD1010 and HD2000 only) Specifies on which port UDP packets are received. REGISTRYSECTION Specifies the registry section where registry input is stored. If the registry section name is not specified in the interactive playlist, registry input appears in the User section of the registry. See Using the registry for additional information.
You can have as many elo events as you wish. Events can overlap touch areas, but in this case, you should only use one at a time (see the demo example and how it uses a touch area that covers the entire screen when not in the main menu). NOTE: You can also use elor instead of elo. They are interchangeable. eloc (HD810, HD1010, and HD2000 only) Triggers with a USB Mouse or Elo Touch Screen press within a circular touch.
timeout You can use a timeout event when a video or slide is displaying, or an audio file is playing. For example, use timeout when you want to advance a slide show to the next slide or to exit a looping video after a certain number of seconds of playback. You can have only one timeout event per interactive playlist. The format is: timeout:seconds • seconds represents the number of seconds after the video/image/audio starts that the event will trigger.
STATE After the EVENTS row, the interactive playlist may include one or more STATE rows. These rows begin with the keyword STATE. The first cell after the STATE keyword is the name of the video or image file to display, or audio file to play. When the state is entered, this file starts playing. The remaining cells describe what state to jump to when the corresponding event happens. For example, in the demo example, the first state is DEMO_MENU.BMP.
• gpios: Turns on the specified GPIO’s; unspecified GPIO’s are turned off. Examples Demo_menu.bmp:gpios(1;3;5) When BrightSign enters the demo_menu.bmp state, LED’s 1, 3, and 5 are turned on; the other LED’s are turned off. aq.ts:gpiosOn(2) When BrightSign enters the aq.ts state, LED 2 is turned on and the other LED’s are unaffected. ppt10.bmp:gpiosOff(0;2;4) When BrightSign enters the ppt10.bmp state, LED’s 0, 2, and 4 are turned off; and the other LED’s are unaffected. product1.
Controlling udp output from an interactive playlist To control udp output for a particular state, add a udp command to the second column of the state specification in the interactive playlist. When BrightSign enters the udp state, the specified string is output via the ethernet connector. The format is: udpSend: Preloading images The autoplay script preloads still images so that appear automatically when a user triggers their display.
Simultaneous states within a single interactive playlist (HD2000 only) Within a single interactive playlist, you can create an interactive presentation with simultaneous states. For example, you can: • Play an HDMI slide show at the same time as an analog audio file. • Plays a video with English audio in the main speakers, French audio in headphone #1, and Spanish audio in headphone #2. The various states can run simultaneously and independently.
Interactive playlist examples The BrightSign demo shows that you can design powerful interactive signs using interactive playlists. The following examples illustrate how easy it is to use and understand interactive playlists.
Example 2 contains two events: an elo event (used for ELO touch screens or any mouse input) and a timeout event. The clickable/touch area is defined as the whole screen. One touch or click starts the slideshow. When this demo starts, BrightSign displays MENU.BMP since it’s in the first STATE position. • There is no timeout entry for MENU.BMP, so if there is no mouse or touch screen input, MENU.BMP remains onscreen forever. • MENU.BMP has one touch/click event. When MENU.
EXAMPLE 3: Slideshow that advances only when a click / touch occurs Example 3 has only 1 event, the same elo event as Example 2. • There is an elo event entry for each image, so the next image plays when there is a mouse click or touch activity anywhere onscreen. • There are no timeout events in this demo. Because Example 3 only has an elo event, and no timeout events, the user must click or touch the screen to advance the slideshow.
EXAMPLE 4: Video and slide playback using button input Example 4 plays two videos and three images and it contains five events: three button events, a timeout event, and a videoend event. When Example 4 starts, BrightSign displays MENU.BMP, since it’s in the first STATE position. • If the menu is being displayed, pressing button 1 starts the attract video; pressing button 2 starts the showcase video; and pressing button 3 starts the slideshow.
EXAMPLE 5: Simultaneous states in a single interactive playlist • • • • 43 • •
Example 5 contains three simultaneous states. • The first state specifies the video mode, image mode, and audio output for video. In this case, the keyword VideoPlayerAudioOutput directs BrightSign to output stereo PCM via the SPDIF audio connector. This machine uses button 0 and the videoend event to control the videos and the image. • Note the NEXT keyword on line 10; it signals the beginning of another state. • The second state uses analog audio output through the Audio 2 connector.
Using rollover events (HD810, HD1010, and HD2000 only) You can define either a rectangular or circular rollover region. To setup a rollover region, use either of the following keywords in the events row: NOTE: When the x_origin : y_origin are set to -1:-1, the starting position for the ON and OFF images are also the starting coordinates for the rollover region. This is true for both rectangular and circular rollover regions.
• off_bitmap represents the name of the bitmap image that displays when the mouse is not within the defined region. • x_origin,y_origin represents the coordinates for the center of the rollover image. EXAMPLE 6: Rectangular rollover region Example 6 shows what you would enter in the interactive playlist to define a rollover region. In this example: • Starting position is 765, 674 • Rollover region is 96 pixels wide and 43 pixels high • Rollover region is enabled • On and off images are NEXT_ON.
Example 7 plays a simple slideshow with three images. It has two rectangular rollover region events and one timeout event. Examples 7.1 and 7.2 are the same as Example 7, but they are expanded to make them easier to read. • If nothing is clicked or touched, the slide show starts automatically after the 10 second timeout, and then returns to the menu after it finishes. • Similar to a standard elo entry, entering the rollover area, advances to the next slide until you reach MENU.BMP.
EXAMPLE 7.2: 3 images with rollover regions Example 7.2 shows that each of the 3 images has a rollover region that is 95 pixels long by 43 pixels tall. • When the cursor is outside this area, BrightSign displays BACK_NOTLIT.BMP. • When the cursor is inside this area, BrightSign displays BACK_LIT.BMP. Scheduling playback (HD210, HD810, HD1010, and HD2000 only) You can play videos, still images, and playlists at scheduled times using the autoschedule.txt file.
Valid syntax for Date/Time parameters: • • • • • • Year: 4 digit integer from 2000 to 2038 Month: 2 digit integer from 01 to 12 Day: 2 digit integer from 01 to 31 Day of Week:the following 3 letter abbreviations: Sun, Mon, Tue, Wed, Thu, Fri, Sat Hour: 2 digit integer from 00 to 23 Minute: 2 digit integer from 00 to 59 In the AUTOSCHEDULE.TXT file, the line following a date/time specification must be an interactive playlist file, playlist file, video file, or image file.
Another example AUTOSCHEDULE.TXT file: 2009/12/15-*-15:20 image.png 2009/12/25-*-16:16 music.bsp 2010/1/*-WED-16:00 video.ts 2010/1/*-*-07:00 breakfast.bsp 2010/1/*-*-14:00 demo.csv In this example, BrightSign displays the image IMAGE.PNG starting on December 15, 2009 at 3:20 PM. On December 25, at 4:16 PM, the playlist MUSIC.BSP starts. The next specification indicates that VIDEO.TS starts playing at 4:00 PM every Wednesday in January, 2010. The playlist BREAKFAST.
Chapter 5 Working with Zones •••••• What are zones? With BrightSign zones you can divide the screen into rectangles and play different content in each rectangle. You can create the following types of zones: • VideoORImages: This zone supports videos and images. You can create only one zone with video (either a VideORImages zone or a Video zone). • Video: This zone supports videos. You can create only one zone with video (either a VideORImages zone or a Video zone).
EXAMPLE 1: Multi-zone examples Can I customize the zones? Here are some of the things you can customize in your zones: • Background screen color: Specify the background color for the display. • Font: Choose a true type font for Text and RSS playback. • Parameters: Control settings for RSS and Text zones.
Using zones with playlists The easiest way to use zones is with playlists.
Example 2 shows a presentation with five zones: • Zone 1 is the main video zone. • Zone 2 is the clock zone in the top right. • Zones 3 and 4 are the two image zones to the right. • Zone 5 is the RSS zone at the bottom. The following explains each line in the Example 2 playlist: • EnableZones: This must be the first keyword in your playlist when using zones. • VideoMode: This keyword sets the video resolution (see Playlist commands for details).
The three numbers after the RSS dimensions represent the following: • 3 (1st number): Represents the number of lines to display • 0 (2nd number): Indicates whether the text is animated or static (0 for animated, 1 for static) • 4 (3rd number): Represents the number of seconds to display each segment EXAMPLE 3: 5 zones with clock and text • • • • 55 • •
Example 3 is similar to Example 2, but the RSS zone is replaced with a Text zone. The following explains the Text zone entry: • DefineZone TEXT: This keyword creates a text zone. In addition to providing the size and location of the zone, you must also specify the strings you want to display by using the STRING keyword. You can use as many STRING entries as you want.
When specifying the color values, the a (alpha) value is optional. If you don’t specify an alpha value, it defaults to 255. The alpha value has no effect on the foreground text color or background screen color. However, the alpha value does effect the background color for individual zones (RSS, Text, and Clock) as well as the background text color. The alpha value is between 0 and 255 (0 [zero] is transparent and a value of 255 is opaque).
Comix Tour example The Comix Tour demo illustrates zones in action. This section provides the playlist that created the demo, so you can see how the playlist controls the demo.
The sections that follow show the playlist for Comix Tours demo: Global settings EnableZones VideoMode 1920x1080x60i BackgroundScreenColor 181:181:181 'color gray71 Zone 1 – video or images REM ************************************************************************ DefineZone VideoOrImages 40,60,1344,756 audiochan 0 'analog audio NewEnglandFishingWithFlyByLogo-ZonesDemo.
Zone 3 - images REM *********************************************************************** DefineZone Images 1384,520,536,356 Slideinterval 4 '4 seconds between images Transition 19 ' slides from right ZoneWorld_00.png ZoneWorld_01.png ZoneWorld_02.png ZoneWorld_03.png ZoneWorld_04.png ZoneWorld_05.png ZoneWorld_06.png ZoneWorld_07.png ZoneWorld_08.png ZoneWorld_09.png ZoneWorld_10.png ZoneWorld_11.png ZoneWorld_12.png ZoneWorld_13.png ZoneWorld_14.png ZoneWorld_15.png ZoneWorld_16.png ZoneWorld_17.
ZoneWorld_26.png ZoneWorld_27.png ZoneWorld_28.png ZoneWorld_29.png ZoneWorld_30.png ZoneWorld_31.png ZoneWorld_32.png ZoneWorld_33.png ZoneWorld_34.png ZoneWorld_35.png Zone 4 - text REM *********************************************************************** DefineZone Text 160,890,1600,120 3 0 1 ForegroundTextColor 75:75:75'silver 16 BackgroundTextColor 200:200:200:0 Font CF:/ComicSansMSBold.ttf STRING COMIX TOURS. Prices so good, they're comical! http://wwww.comixtours.
Chapter 6 Working with Scripts •••••• What are scripts? A script is a simple program that controls behaviors based on events, such as changing video playback when the user presses a button. Scripts are commonly used on PCs and Web Sites. For example, Microsoft Office macros are often Basic Scripts. Adobe Flash apps often rely on ActionScripts for their logic, and web pages are often driven by scripts written in PHP, Perl, or JavaScript.
Sample script Here is how to create a very simple script: 1 Using a text editor, create a file called HELLO.BRS by entering this line: print “hello world” 2 3 4 5 6 7 Save HELLO.BRS into the root directory of a SD card. Insert the SD card into BrightSign. Connect the serial port of BrightSign to your PC using a null modem cable. On your PC, run HyperTerminal. Turn on BrightSign and wait for the Roku> shell prompt to appear. Type: script hello.brs You should see “hello world” on your PC screen.
Examples A good way to learn BrightScript is to look at or modify existing scripts. You can also test BrightScript commands using the shell. Here is an example: Welcome to the Roku Shell version 3.04 Release Type '?' for help or 'help ' for help on . Roku> script BrightScript Micro Debugger. Enter any BrightScript statement, debug commands, or HELP.
Using the GPIO control port HD410, HD810, and HD1010 units have a DB15 General Purpose Input Output (GPIO) Port. HD2000 units have a DB25 General Purpose Input Output (GPIO) Port. On the HD410, HD810, and HD1010, the GPIO port has 8 bidirectional ports. On the HD2000, the GPIO port has 12 inputs and 6 outputs. You can connect the inputs directly to buttons or switches and the outputs directly to LEDs.
Here is an example of a script for the HD410, HD810, or HD1010 that flashes an LED for half a second each time the user presses a button on the BrightSign button/LED board. print "BrightSign Button-LED Test Running" p = CreateObject("roMessagePort") tmr = CreateObject("roMessagePort") gpio = CreateObject("roGpioControlPort") gpio.SetPort(p) gpio.EnableInput(0) gpio.EnableInput(1) gpio.EnableInput(2) gpio.EnableInput(3) gpio.EnableOutput(4) gpio.EnableOutput(5) gpio.EnableOutput(6) gpio.
The following example script for the HD2000 flashes an LED for half a second each time the user presses a button on the BrightSign button/LED board. print "BrightSign Button-LED Test Running" p = CreateObject("roMessagePort") tmr = CreateObject("roMessagePort") gpio = CreateObject("roGpioControlPort") gpio.SetPort(p) event_loop: msg=wait(0, p) if type(msg)<>"roGpioButton" then event_loop butn = msg.GetInt() if butn > 5 then event_loop gpio.
Chapter 7 Getting Help •••••• Learning more and support The following resources can help you get the most from your BrightSign: • Refer to each of the following BrightSign documents.
Frequently asked questions What video frame rates does the HD2000 support? The HD2000 supports output frame rates of 50Hz and 59.94/60Hz. The following video frame rates are supported: • 1080: 23.98p, 24p, 25p, 29.97p, 30p, and 59.94/60p • 720: 23.98p, 29.97p, and 30p How do I create portrait mode content on BrightSign? You can create portrait mode content from your authoring application (e.g. PhotoShop, After Effects, etc). To preview your work as you go, you will need to work in a 1080x1920 canvas.
How many displays can I connect to the BrightSign? The HD110, HD210, HD410, HD810, HD1010, and HD2000 all support playing the same content on multiple displays. • HD2000: Connect up to 3 displays at the same time. Both HDMI and Component ports are active at the same time when in use. You can connect 1 HDMI and 2 Component displays. The VGA output is active and can be connected to a component display, with an adapter.
What is the maximum number of BrightSign units I can synchronize? • GPIO: Using the GPIO port, you can connect up to 18 HD2000s to a single Master unit. The HD410, HD810, and HD1010 support up to 24 units connected via GPIO. The HD810 and HD1010 plus the Expander module, can support up to 78 BrightSign units connected via GPIO. You can connect up to 7 Expander modules with each Expander adding support for an additional 54 units—that's a total of 402 units.
Troubleshooting If you are still having problems after following the troubleshooting tips in this section. General troubleshooting Before attempting to resolve any playback problem on your BrightSign, please start with this checklist. Download a BrightSign demo. 2 Try a different flash card, or if you have only one flash card, reformat your flash card. 3 (HD2000 only) If a CF card isn’t working, try an SD card. SDHC not supported.
BrightSign isn't booting up properly / Err light is on or flashing (HD110, HD210, HD410, HD810, and HD1010 only) 1 Try starting BrightSign without a flash card inserted. 2 Try reinstalling the firmware. NOTE: If the error LED is flashing, please record how many times it flashes before pausing, and contact BrightSign Customer Support.
Problems with automatically playing files Problems playing one or more files If you’re trying to loop one or more files without a playlist, please check the following: Make sure you don’t have any of the following autoplay files on the flash card: AUTOPLAY.BSP, AUTOPLAY.CSV, or AUTOSCHEDULE.TXT. 2 Set your PC to show file extensions and make sure your images are JPG, BMP, or PNG files, your videos are TS files, and your audio files are MP3 files.
Download and install the latest BrightSign software. If you’re already using the latest software, reinstall the software (see Step 2: Get the latest BrightSign software for details). 6 Try using a different brand and/or size SD card. 7 Re-create content with different software, if possible. 5 Video output is red, green, or distorted Red or distorted video output can occur if you’re using a VGA display and Brightsign is set to a non-VGA resolution.
Content Playback If you can play content that you downloaded under Software Download, but you can’t play videos, images, or audio in your own presentations, follow the steps in this section to troubleshoot the problem. My Image files don't play on BrightSign If your image isn't playing, it might be an unsupported format, or it might not meet the required specifications to play on BrightSign.
My video quality is poor Poor video quality is normally due to a problem with the file or to bad encoding. Make sure that the format of your video content matches the properties of the display resolution, and that you’ve chosen the highest quality output possible. For example, if your videos is 640x480 and you scale it to 1920x1080, this degrades the quality.
My audio files don't play on BrightSign If your audio file isn't playlist, it might be an unsupported format, or doesn't meet the required specifications to play on the BrightSign. Make sure your audio file meets the following requirements: • MP3s with a 44Khz or 48Khz • (HD2000 only) WAV files are also supported Troubleshooting Playlists Before attempting to resolve any playlist problems on BrightSign, please start with this checklist.
The demo playlist I downloaded works, but my playlist does not. 1 Try simplifying the playlist by removing any comments or keywords, and just include one or two files. 2 Try editing the playlist you downloaded, and using the modified playlist. 3 If you're using a word processor to edit your playlist, try using Notepad on the PC or TextEdit on the Mac. Playlists must be plain text files.
1 2 3 4 5 6 The interactive demo I downloaded works, but my interactive playlist does not Remove any non-alpha numeric characters from your file names. For example, the symbol + is not acceptable in a file name. Make sure that every file used in the interactive playlist is listed in the STATE column and that each file is listed only once. If you need to list a file twice in the STATE column, then create a duplicate of that file, with a different name. Check the spelling of the file names.
BrightSign and accessories BrightSign isn’t booting up properly / random lights lit When BrightSign turns on, it cycles through the Connector Activity and Video Mode lights. The only two lights that should remain lit at the end of the startup process are the Video Mode light, normally 1024x768, and the Power light. Download and reinstall the BrightSign software (see Step 2: Get the latest BrightSign software for details). 2 If reinstalling the BrightSign software doesn’t fix the problem.
SD card is not recognized by BrightSign If BrightSign doesn’t see any content on your SD card, that card may not be compatible with BrightSign. Reformat your SD card in FAT32 format. 2 Try a different brand and/or size card. 3 If you’re using an HD2000, make sure you’re using an SD card, not an SDHC card. 1 Video selector switch does not work The video selector switch is not currently implemented on the HD2000. USB mouse is not responding BrightSign works with many different brands of USB mice.
USB keyboard is not responding BrightSign works with many brands of USB keyboards. To use a keyboard, you must write a custom script. The buttons supported by the AUTOPLAY.CSV are for input from the GPIO port. Disconnect the keyboard from BrightSign and reconnect it. 2 Connect your keyboard to BrightSign using a USB hub. 3 Try a different USB keyboard. 1 Elo touch screen coordinates aren’t working properly If the Elo coordinates appear to be reversed or flipped when using AUTOPLAY.
Chapter 8 Advanced Topics •••••• Selecting Compact Flash cards When you use BrightSign, your content and scripts resides on a Compact Flash (CF) or Secure Digital (SD) card. Although the CF/SD interface is standardized, there are a wide range of performance, compatibility, and reliability issues among CF/SD card brands and models. BrightSign strongly recommends that you use industrial rated CF/SD cards with BrightSign.
various strategies. These strategies include wear leveling when writing, automatic error correction when reading, re-writing a block that is becoming susceptible to read errors, and moving blocks around in the NAND chip that are repeatedly read over and over. A typical BrightSign application includes an attract video loop. If this video is fairly short, then a small number of flash blocks are read repeatedly.
Other ways to update your BrightSign software Download the latest software. a Go to the BrightSign web. b Click the Software Downloads link. c Compare the software version number with the number on your BrightSign screen. d If your BrightSign software is older than the software on the web site, click the Software link to download the latest software. 2 Extract the software update file onto your CF/SD card and give it one of the following names: • UPDATE.
• If you named the file UPDATE.ROK, the file deletes when the update finishes and the unit reboots. NOTE: If the card was formatted with NTFS or HFS+, then the UPDATE.ROK file does not delete and the unit does not reboot after the update. • If you named the file UPDATE_SAVE.ROK, the upgrade file does not delete and the unit does not reboot. Generating HD content for an HD2000 using Final Cut Pro From within Final Cut Pro: 1 2 3 4 5 Open an existing sequence or create a new one.
5 In the Inspector window, click Encoder (second button from the left) and make sure that the resolution, frame rate, and aspect ratio are correct. NOTE: Most HD sources (HDCAM, HDV etc) set the resolution to 1440x1080. Therefore, if you’re creating 1080i or 720p content, you need to click Change next to the appropriate field and adjust the settings for your content. 6 After you confirm that the settings are correct, click Submit.
8 In the Inspector window, click Encoder (second button from the left) to confirm that the resolution, frame rate, and aspect ration are correct. NOTE: Most HD sources (HDCAM, HDV etc) set the resolution to 1440x1080. Therefore, if you’re creating 1080i or 720p content, you need to click Change next to the appropriate field and adjust the settings for your content. 9 After you confirm that the settings are correct, click Submit.
4 5 6 7 • HD410, HD810, and HD1010 • 115200 baud • 8 data bits • No parity • 1 stop bit • NO flow control • TTY mode enabled Create a CF/SD card with some test files on it (BMP graphics, 48 kHz MP3 files, MPEG-2 video, etc), and then insert the card into the BrightSign unit you connected to your PC. Connect speakers and/or a monitor to BrightSign. Turn on your BrightSign. After a few moments you should see the BrightSign shell appear. It should also show you the software version number.
To play a video named MYVIDEO.TS on the SD card, use: videoplay myvideo.ts To play a video with a space in its name, such as MY VIDEO.TS, use: videoplay “my video.ts” To change the volume level (0 - 100) to 75% when playing a video or audio, use: videoplay volume 75 audioplay volume 75 To change the video mode, use this format with the videomode command: videomode 1024x768x60p To display an image, use this format with the imageplay command: imageplay slide1.
To explicitly refer to a card from within a script, use the following: • For compact flash cards CF:/ • For SD cards SD:/ When BrightSign runs an AUTORUN.BRS script, it sets the current drive to the drive containing AUTORUN.BRS, so references to files on the same card do not need the CF:/ or SD:/ prefixes. Testing CF/SD cards BrightSign works with most CF/SD cards, but is not compatible with all CF/SD cards. You can test your card by using the dir / shell cmd, and/or using the shell cmd readperf.
Testing scripts, playlists, and interactive playlists The BrightSign shell enables you to test playback and see debug output. From the BrightSign shell you can start your script manually and view output from the script. Manually starting a script You can start a script from the shell by using the script command. Follow the directions earlier in this section to connect BrightSign to your computer, and access it using HyperTerminal.
Testing autorun and interactive playlist files Running AUTORUN.BRS in debug mode provides detailed output to the BrightSign shell while the script is running. To begin testing the AUTORUN.BRS script in debug mode, do the following: Copy your content, interactive playlist, and AUTORUN.BRS to your CF/SD card. 2 Open AUTORUN.
To begin testing your custom script: 1 2 3 4 5 Copy your content and script file to the CF/SD card. Name your script RUN.BRS. You can call it anything, as long as it’s not AUTORUN.BRS, so it doesn’t start automatically. Add debug = true as the first line of your script. This command enables you to see output from the print statements you added to your script. Insert your CF/SD card into your BrightSign and add power. When the Roku prompt appears, type the following: script run.
Updating BrightSign software from the BrightSign Shell BrightSign is pre-programmed with two primary software images: a safe mode and a run mode. The safe mode software image is write-protected, and you cannot change it once programmed by the factory. The main purpose of safe mode is to validate that the run mode ROM image is not corrupt and to boot your BrightSign. In addition, safe mode can upgrade or re-program the run mode ROM image.
Using the registry BrightSign has an I2C EEPROM with 2K bytes of memory that supports the storage of persistent settings. The BrightSign software uses the registry object to read and write BrightScript data to this eeprom. The purpose of the registry is to enable customers to store usage statistics and other small amounts of information that may change regularly. Individual items are stored in the registry through the use of registry keys and values.
Displaying registry contents from an interactive playlist To display the contents of the registry from an interactive playlist, add a row to the table with the word DisplayRegistry in the column to the right of the keyword STATE. The remainder of the row is like any other row in the table – it contains other states to transition to when events occur. Elsewhere in the table, add the state DisplayRegistry in the column for the event that you want to trigger the registry to display.
Setting the date/time on BrightSign The HD810 and HD2000 have a real-time clock that you can use to schedule content playback. In order to use the scheduling features, you must first set the date and time on BrightSign. BrightSign has written a script that provides an interactive means for setting the date/time on BrightSign. The script is named SETDATETIME.BRS and is available at ction. Instructions for using the date/time script: 1 2 3 4 5 6 7 Go to BrightSign web and click the Software Downloads link.
Using a custom boot script and logo You can change the startup logo or add a boot script. Both the logo and boot script are stored in the internal FLASH and have a size limit of 200KB. Using your own boot logo 1 2 3 4 5 6 Save your logo in one of the following file formats: BMP, 8 bit indexed, or RLE encoded. Copy your logo to a CF card. Connect your BrightSign to a PC using a null modem cable (see Accessing the BrightSign shell for details).
aspect ratio. What this means from a practical point of view is that you should author the content for 16x9 if you intend to use a 16x9 display mode (any component mode). If you intend to use a 4x3 display mode (any VGA mode, for example 1024x768), then you should author the content for 4x3. If you author your video for widescreen, but play it back at 1024x768 or 640x480, it will look squashed. It isn’t automatically letter-boxed like when played on a DVD player.
Configuring BrightSign using DHCP To connect the BrightSign to your network: Use an ethernet cable to connect your BrightSign to your network. 2 Insert your CF/SD card with your content and playlist into your BrightSign and add power. BrightSign automatically requests an IP address from your network when it boots.
8 When prompted, restart BrightSign to finish. TIP: You can also copy and paste the following into a text file, and then change the network settings to match your own. After you make the changes, save the file as AUTORUN.BRS. REM Start of script nc = CreateObject("roNetworkConfiguration", 0) nc.SetIP4Address(192.168.1.200) nc.SetIP4Netmask(255.255.255.0) nc.SetIP4Broadcast(192.168.1.255) nc.SetIP4Gateway(192.168.1.1) nc.AddDNSServer(192.168.1.1) nc.AddDNSServer(208.67.222.222 ) nc.AddDNSServer(208.67.220.
• HTTP / socks proxy: BrightSign does not currently support HTTP proxy or socks proxy configurations. Although BrightSign has a private IP address, it cannot make connections to the Internet by itself. Instead it has to connect to a proxy server and ask it to make the connection to the Internet. This can either be a protocol specific proxy (like many web proxies/caches) or a protocol agnostic proxy (e.g. socks).
Using the NetworkTimer keyword When using the Simple Networking method, you need to add a NetworkTimer keyword to your playlists. You can use the NetworkTimer keyword with an RSS feed or the automatic content download feature. The NetworkTimer keyword can take the following forms: • NetworkTimerPeriodic: Instructs BrightSign to check your network folder at regular intervals. For example, you can update an RSS feed every 15 minutes.
Chapter 9 Product Specifications •••••• BrightSign features Display resolutions 1024x768 (HDMI & VGA out) 1280x768 (VGA out) 1360x768 (HDMI & VGA out) 480p (HDMI & component out) 576p (HDMI & component out) 720p (HDMI & component out) 1080i (HDMI & component out) 1080p (HDMI out) Video compression standards MPEG-1 MPEG-2 transport streams with MP3 audio (TS) MPEG-2 program streams Picture formats BMP PNG JPEG (JPG) HD110 HD210 HD410 HD810 HD1010 HD2000 X X X X X X X X X X X X X X X X X X X X X X X X X X
Audio formats HD110 AC3 pass through X MP3 decode out to analog and SPDIF X WAV decode out to analog and S/PDIF USB device support HD110 Touchscreen Speakers Mouse Keyboard Trackball Barcode scanner USB hub support Front panel HD110 Power LED X IR receiver Compact Flash (CF) card slot (up to 128 GB cards) MMC flash card slot (up to 4 GB cards) SD flash card slot (up to 4 GB cards) X SDHC flash card slot X Video mode select button LEDs: connector activity and video mode X Power Typical power consumption HD2
Back panel connectors Power 3 audio out stereo 1/8” mini plugs VGA Component out 3 RCA jacks: Y-Pr-Pb HDMI out 2 high-speed USB host ports 10/100 ethernet jack DB25 control port (for buttons & LEDs) RS-232 serial port Optical SPDIF audio out 1/8” 5V serial port 8 position dip switch Other features Auto play and looping video support Playlists Interactive playlists (CSV files) Scripting Real time clock Single files larger than 4GB Upgradable software Customer configurable DIP switches Scheduling playback Per
Supported media types BrightSign supports the following media types: MPEG-2 video files (program streams on the HD2000—VOB/MPG files, or transport streams on the HD110, HD210, HD410, HD810, and HD1010—TS files) These are the same types of files that are found on DVDs. You can create MPEG-2 video files using any video editing software, such as Pinnacle Studio or iMovie. These video files should meet the following parameters: • Video size up to 1080i (1920x1080 interlaced). • Bit rate up to 25Mbps. • Scale.
MP3 audio files Stereo or mono files that meet the following parameters: • 48 kHz • 44.1 kHz NOTE: BrightSign has no sample rate conversion. Certain USB speakers only support a sample rate of 48 kHz. When using a USB speaker with this characteristic, BrightSign outputs all audio at this rate regardless of the sample rate it was recorded at. WAV audio files 16 bit linear PCM data. Dolby Digital (AC3) 5.1 audio in a video file o • 5.1 AC3 audio playback from SPDIF and HDMI outputs.
Supported input devices With BrightSign software you can connect the following devices to a BrightSign: • • • • • • • • • • • • • • Elo Touch Screens Many brands of USB Keyboards Many brands of USB Mouse or Trackballs Many brands of USB Bar Code Scanners (these appear as a keyboard) Quadravox Serial Button Board Any GPIO button, signal, or LED (your custom board or led display). BrightSign has a test button board available for purchase on our estore.
USB mice BrightSign has tested the following mice with BrightSign: Type Connection Brand Model Name Comments Ball Wired Belkin F8E841-BLK MiniScroller Mouse Optical Wireless Belkin F8E874 MiniWireless Optical Mouse Optical Wired Dynex DX-OM20 Optical Wireless Kensington 72216 PilotMouse Optical Wireless Optical Wired Logitech M-BE58 First/Pilot Wheel Mouse Optical Wired Logitech M-UV55A Mini Optical Mouse Optical Wired Logitech M-BT96a Optical Mouse (3 buttons) Trackb