Roku HD2000 manual

BrightSign Users Guide Matches: BrightSign HD2000 Version: 1.2.27 AutoPlay Script Version: 1.2 California, USA www.rokulabs.com[...]

2 INTRODUCTION ................................................................................................................... .......... 4 BRIGHTSIGN FEATURES............................................................................................................ .. 5 EXAMPLE BRIGHTSI GN SETUPS ..............................................[...]

3 S ETTING THE D ATE /T IME ON B RIGHT S IGN (HD2000 ONLY ) ........................................................... 50 W RITING B OOT S CRIPT & L OGO TO R OM ...................................................................................... 50 W IDESCREEN VS . 4 X 3 D ISCUSSION ...........................................................[...]

4 Introduction The Roku BrightSigns are comple te standalone Digital Sign or Kiosk Controllers that can play content from standard Flash memory cards. BrightSigns have uniquely high quality video playback. This is achie ved via professional quality dec oders and a scaler that can produce crisp clean 1920x1080 interlaced video from high definition m[...]

5 BrightSign Features BrightSign HD600 BrightSign HD2000 Display Resolutions NTSC * PAL * S-Video (requires adaptor) * 640x480 (VGA out) * 800x600 (VGA out) * 1024x768 (VGA out) * * 480p (Component out) * * 480p (HDMI out) * 576p (Component out) * 576p (HDMI out) * 720p (Component out) * * 720p (HDMI out) * 1080i (Component out) * 1080i (HDMI out) [...]

6 Compact Flash card slot * * SD/MMC flash card slot * Video mode select button * * LEDs: connector activity and video mode * * Back Panel Connectors Power * * 3 audio out stereo 1/ 8” mini plugs * * VGA (also supports XVGA) * * Component out 3 RCA jacks: Y-Pr-Pb * * HDMI out * 2 High Speed USB host ports * * 10/100 Ethernet jack * * DB25 control[...]

7 Example BrightSign Setup s Probably the simplest way to use BrightSign is to put a video or set of still images on a CompactFlash card, and use a VGA cable to co nnect the BrightSign to a flat panel monitor. Variations on this setup include us ing the component out to connect to a High Definition display (like a Plasma TV), or even connecting to [...]

8 Examples Here are some examples of what you can do with a BrightSign: • Display a looping video with “DVD+” qual ity on a variety of monitor types. • Display a looping slide s how in high definition. • Play looping music. • Combine any of the above. • Create interactive di splays that play video, photos , or audio in response to cus[...]

9 your monitor is configured to the correct i nput type and is connect ed using the correct cable. You should now see the demo in various video modes, and see how it auto scales and supports widescreen or 4x3. Note that the front panel “video mode” button is not currently supported on the HD2000. Software Versions The version of the BrightSign [...]

10 BrightSign Document ation The complete set of BrightSign documentation is available at www.rokulabs.com/BrightSign . It includes: • BrightSign Installation and Regulatory Guide • BrightSign User Guide (this document) • BrightSign HD600 Hardware Guide • BrightSign HD2000 Hardware Guide • BrightSign BrightSc ript Reference • BrightSign[...]

11 Getting S t arted Step 1: Get Hardware You Need To start using the BrightSign, you’ll need the following hardware. • Display – Any monitor, TV, or Elo touch screen with a VGA, Component, Composite (HD600 only), or HDMI (HD2000 only) inputs. • CF Card Reader/Writer o A Compact Flash card to st ore the demo or your content. Read “Selecti[...]

12 Media Types Supported The following media types are supported: • MPEG-2 Video Files (aka “VOB” or “MPG” files) - These are the same types of files that are found on DVDs. They can be authored using any video editing software such as Pinnacle Studio or iMovie. Video sizes up to 1080i (1920x1080 interlaced) are supported with bit rates u[...]

13 Playing Media with BrightSign Media can autoplay from a CompactFlash card upon power-up, play via a script on a CompactFlash card, or be tested us ing the serial shell commands. NOTE: On an HD600, video will come out the VGA connector , and the resolution will be 1024x768 unless you have changed this in your .CSV, Playlist, or Script, or by usin[...]

14 2. Go to www.rokulabs.com/brightsign and download the “autoplay.zip” file. This contains a script named autorun.bas. C opy autorun.bas into the root directory of your CF card. 3. Insert the CF card into the BrightSign, a pply power, and after a few mom ents, the video should play and auto loop. Auto Playing a Playlist upon Power-up A playlis[...]

15 1. Create the script using a text edito r (see th e script section of this manual for more information) 2. Save it to the root directory of your CompactFlash card with the nam e “autorun.bas” Creating a Schedule for Auto Playing Videos, Still Images, Playlists, or CSV Files To play videos, still images, playlists, or CSV files at scheduled t[...]

16 Playlist s A BrightSign playlist is a text file that e nds in “.bsp” (BrightSign Playlist). It contains the names of the files to play, in the order th ey should play. Files are played in sequence, one after the next. This means that it is not currently possible to have a playlist that plays audio and a video at the same time, for example. G[...]

17 Playlist Commands Here is the list of commands th at can appear in a playlist: .bmp, .mp3, .mpg, .vob , .png (HD2000 only) Any line that is a file name that ends in one of these extensions is played. Names m ay contain spaces. .bsp You can call another playlist from within a pl aylist putting the playlist filename on a line by itself. For exampl[...]

18 audiochan # (default is 2 ) Since there are three analog outs, if analog is selected you must also use the "audiochan" cmd: • audiochan 2 -- output 1 (this is not a typo) • audiochan 1 -- output 2 • audiochan 0 -- output 3 volu me # (default is 100 ) Sets the volume to a value between 0 and 100. For example: volum e 100 videomode[...]

19 lighton # lightoff # These two commands are used to set or clea r one of the GPIO outputs. The number can be any integer between 17 and 22. For example: lighton 17 sets LED 0 on the button board. waitbuttonany This will pause until any of the GPIO buttons is pressed. pause # This will pause for the specified number of s econds. The number must b[...]

20 Creating Interactive Displays With BrightSign you can create displays that respond to user input. For example, give the customer options of watching different vi deos depending on which button is pressed. To accomplish this with BrightSign, you need to decide what the input device will be, and you will need to either (a) use Microsof t Excel to [...]

21 STATE bs5.bmp bs6.bmp STATE bs6.bmp bs7.bmp STATE bs7.bmp bs8.bmp STATE bs8.bmp bs9.bmp STATE bs9.bmp bs10.bmp STATE bs10.bmp demo_menu .bmp Keywords The first two lines use the optional “video mode” and “imagem ode” keywords. These items are optional, but if used, can have thes e parameters (in the column af ter the keyword VIDEOMODE or[...]

22 • 3 - Scale to fill. The image is stretch ed so that it fills the scre en and the w hole image is viewable. This m eans that the aspect ratio will not be m aintained if it is different to that of the current screen resolution. FLIPELO This keyword isn’t used in the example above. The FLIPELO keyword should only be used with a touch screen if[...]

23 • button - Triggers on a GPIO Control Port button press. The format is: button:number, where number is between 0 and 12. • timeout - When a video or slide is displa ying, you can use a “timeout” event. The format is: timeout:seconds where seconds is the number of seconds after the video/im age starts that the event wi ll trigger. This ev[...]

24 In the example above, the st ate cars.mpg is in the “elo :110:180:350:400” event column. To track the number of times that th e user activates this transition, enter “cars.mpg:counter(TouchToDemoMenu) in place of “cars.mpg”. The value in the registry corresponding to the TouchToDemoMenu key is incremented when the corresponding event i[...]

25 • ppt10.bmp:gpiosOff(0;2;4) o LED’s 0, 2, and 4 are turned off; ot her LED’s are unaffected when the ppt10.bmp state is entered • product1.bmp:gpios() o All LED’s are turned off when the product1.bmp state is entered Preloading Images The autoplay script tries to be smart about preloading still images so that when a user triggers their[...]

26 State File (CSV) Examples The BrightSign Demo described above show s that you can design powerful interactive signs using easy to understand CSV files. The following examples further illustrate how easy CSV files are to use. Example 1: Sl ideshow that advances au tomatically after the first slide plays Example 1 contains two events, an elo event[...]

27 Example 2: sli deshow that advances onl y when a click / t ouch occurs Example 2 has only 1 event, the same elo event as Exam ple 1. • There’s an elo event entry for each image that plays next image when there’s a click or touch anywhere onscreen. • There are no timeout events in this demo. Because exam ple 2 only has an elo event, and n[...]

28 Example 3: Vi deo an d Sl i de pl ay back , using button i np ut Example 3 contains five events, three button events and a timeout and videoend event. This demo plays two videos and 3 images. When this demo starts, menu.bmp is displayed since it’s in the first STATE position. • If the menu is being displayed, pressing bu tton 1 starts the at[...]

29 OFF image is displayed. This allows buttons to highlight as the mouse cursor m oves over them. Rollover Events Use either of the following keywords in th e events row to set up a rollover region: • Relor – you define a rectangular roll over region using this format: o relor:x:y:width:height:enable_rollover:on_bitmap:off_bitm ap:x_origin:y_ o[...]

30 • Starting position is: 765, 674 • The touch region is 96 pixels wide and 43 pixels high • The rollover region is enabled • The on and off images are: next_on.bmp and next_off.bmp. • The rollover images are display ed in th e same location as the touch region Normally, the on and off image have the sa me dimensions as touch region (wid[...]

31 Example 5.1: Example 5.2:[...]

32 Scheduling Playback (HD2000 only) Videos, still images, playlists, and CSV files can be played back at scheduled times using the autoschedule.txt f ile. This f ile contains a series of date/time specifications, f ollowed by a specification of what to play when the date/time event occurs. The syntax of the date/time specification is as follows: Y[...]

33 specification indicates th at “video.mpg” will start play ing at 4:00 PM eve ry Wednesday in January, 2008. The playlist “b reakfast.bsp” will start playing at 7:00 AM during January, 2008. Finally, “demo.csv” will be la un ched everyday in January, 2008, at 2:00 PM. Note that blank lines can be added (as a bove) to autoschedule.txt [...]

34 9. If you want the script to autor un upon boot, rename it “autorun.bas” Roku Objects As well as the BrightScript language itsel f, BrightSign relies upon a library of “Roku Objects” to expose the hardware to the scri pting language. Each Roku Object provides access to certain capabilities. For example, there is a roVideoPlayer ob ject a[...]

35 Registry (HD2000 only) The BrightSign has an I2CROM with 2K bytes of memory that supports the storage of persistent settings. The purpose of the registry is to enable custom ers to persist usage statistics and other small amounts of inform ation that may change regularly. Individual items are stored in the registry through the use of registry ke[...]

36 msg=p.GetMessage():if type(msg)<>"rotINT32" then clear_events goto event_loop Learning More and Support The following resources can help you get the most from your BrightSign: 1. Visit www.rokulabs.com/brightsign 2. Refer to each of the different BrightSign doc uments available (lis ted at the start of this manual). 3. Visit the [...]

37 T roubleshooting If you are still having problems after trying troubleshooting tips, please contact custom er support at www.rokulabs.com/brightsign for more assistance. Autoplay & General Troubleshooting Autoplay .mpg does not play automatically 1. Verify autoplay.mpg is spelled correctly 2. Verify that the autorun.bas v1.1 or later a nd au[...]

38 8. Contact Roku Customer Support if you are still having problem s. Video output includes artifacts, quality lower than expected The format of video content should be chosen to best match the properties of the intended display resolution. Most of th e video output modes are progressive and so for the highest quality video reproduction, video fil[...]

39 1. Verify autoplay.bsp is spelled correctly 2. Verify that the autorun.bas v1.1 or later a nd autoplay.bsp are both in the root of the CF card 3. Verify you do not have an “autoplay.csv” or “autoplay.mpg” in the root of the CF card. There should only be one autoplay file in the root of the CF card. 4. Check if your PC is set to show file[...]

40 BrightSign Software Update Fails 1. Verify that the update file is named update.rok 2. Verify the update file is in the root of the CF card, not in a sub-directory 3. Try reformatting the CF card as FAT32 4. Try using a different CF card 5. Try updating from the BrightSign Shell. Pl ease see “Device Software and Upgrading” for details. 6. Co[...]

41 USB Mouse is not responding The BrightSign works with many different br ands of USB mice. Before troubleshooting the mouse, please download the BrightSign Demo , and test if your mouse works with the demo. If the mouse works with the demo, then the problem is with your script or the coordinates used in the .csv file. 1. Unplug the mouse from the[...]

42 Appendix Selecting Compact Flash Cards Summary When using a BrightSign Product, your cont ent and scripts are loaded onto a Compact Flash (CF) card. Although the CF interface is standardized, there are a w ide range of performance, com patibility, and reliability issues with different CF card brands and models. Roku strongly recommends that you [...]

43 speed with BrightSign by placi ng a file on it, and using th e shell “readperf” command (see the BrightSign User Guide on shell instructions). BrightSign Compatibility BrightSign is compatible with most CF car ds, but m ay not be 100% compatible with every model. Although there are standards for CF card interfaces, m ost chips are slightly d[...]

44 Device Software (Firmware) and Upgrading The BrightSign is pre-programmed with two prim ary software images: a “Safe Mode” and a “Run Mode”. The Safe Mode software image is write prot ected, and not changed once programmed by the factory. Its main purpos e is to validate that the run mode rom image is not corrupt, and boot the unit. In a[...]

45 The upgrade process is very safe. If for some reason it fails, for example a power failure in the middle of the update, the unit’s “safe- m ode” will still boot a nd will still perform upgrades as above. Updating from the BrightSign Shell BrightSign works with most CF cards, but is not compatible with all. See the “BrightSign Shell ” s[...]

46 7. After a few moments you should see the Brig htSign shell appear. It should also show you the software version number. Verify it is 1.0.72 or greater. List of Shell Commands With the shell running, type: help <enter > for a list of commands. Type the comm and on a line by itself for more inform ation on a particular command. Example Shel[...]

47 imageplay slide1.bm p 1 The current version of the BrightSign so ftware does not support “hot swap” of CompactFlash cards. You m ust put in th e CF card before applying power. Using SD Cards (HD2000 only) To list the contents of a CF card, enter any of the following: dir dir cf:/ dir ata:/ To list the contents of an SD card, enter: dir sd:/ [...]

48 Testing Scripts, Playlists, and .CSV An efficient way to test playback is to us e the BrightSign Shell. By using the shell, you can see “debug output”. From the BrightSi gn Shell you can start your script manually and view output from the script. You can start a script from the shell by using the “script” command. Follow the directions a[...]

49 • Add print statements showing names of files read from the flash card • Add print statements showing th e coordinates of a mouse click To begin testing your custom script: 1. Copy your content and script f ile to the compact flash card. 2. Name your script run.bas . You can call it anything, as lo ng as it’s not autorun.bas, so it doesn?[...]

50 Linux Shell (HD2000 only) The HD2000 has a Linux shell that ca n be accessed via the serial port. To access the Linux shell, enter th e fo llowing at the Roku prompt: exit When done using the Linux shell, ente r the following at the Linux prompt: reboot Setting the Date/Time on BrightSign (HD2000 only) BrightSign has a real time clock that can b[...]

51 7. Assumes logo.bmp is the file nam e of your logo file on the CF card. 8. Reboot the system - your logo should appear Using Your Own Boot Script The script must be self contained. For example, it can't be used to play a playlist or csv file. You can use the boot script to play any content on your CF card (images, audio, and videos). 1. Sav[...]

52 Widescreen vs. 4x3 Discussion BrightSign can be used with widescreen or 4x3 displays. However the use of different display aspect ratios with the various BrightScreen options can often be confusing. In this section we try to clarify what you can expect. Displaying Videos Video and Images are currently treated a little differently. When a video i[...]

53 • Elo Touch Screens • Many brands of USB Keyboards • Many brands of USB Speakers – HD600 only • Many brands of USB Mouse or Trackballs • Many brands of USB Bar Code Scanne rs (these appear as a keyboard). • Quadravox Serial Button Board • Any “GPIO” button, signal or LED (your custom board or led display). Roku has a test but[...]

54 1. DB9 Serial Port - The RS232 serial port can be used to control any serial device or to access the shell. Serial c ontrol is accom plished using BrightScript and the serial object. 2. DB25 GPIO Control Port - For connecting your own LEDs or Buttons (see the GPIO Control Port section of this manual) 3. Line Level Audio O utputs a nd SPDIF - Whe[...]