Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
indent20px

Insert excerpt
BrightScript Version Navigation Menu
BrightScript Version Navigation Menu
nopaneltrue
An roBrightPackage object represents a .zip file. The .zip file , which can include arbitrary content or can be installed on a storage device to provide content and script updates (for example, to distribute updates via USB thumb drives).

...

Code Block
CreateObject("roBrightPackage", filename As String)

ifBrightPackage

Note

ifBrightPackage is a legacy interface. We recommend you use roAssetPool instead to achieve better functionality.

Unpack(path As String) As Void

Extracts the .zip file to the specified destination path. Any preexisting files in the target directory will be deleted as part of this operation. Providing a destination path of "SD:/" will wipe all preexisting files from the card and extract the .zip contents to the root folder.

...

Provides the password specified when the .zip file was created. roBrightPackage  This method supports AES 128 and 256 bit encryption, as generated by WinZip.

GetFailureReason() As String
 
UnpackFile(a As String, b As String) As Boolean

...

 
Code Block
titleExample
package = CreateObject("roBrightPackage", "newfiles.zip")
package.SetPassword("test")
package.Unpack("SD:/")

Using roBrightPackage

...

for Content Updates

BrightSign checks players check storage devices for autorun scripts in the following order:

...

In addition to looking for autorun.brs scripts, BrightSign players look for autorun.zip files that contain the script name autozip.brs. If autozip.brs is encrypted, then the player uses the password stored in the registry, in the section "security" under the name "autozipkey," to decrypt the file. If an autorun.zip file with an autozip.brs file is found, and autozip.bas is brs can be decrypted, then the player will execute the autozip.brs file.The

Warning
titleImportant

The autozip.brs

...

 file cannot reference any external files, as it is the only file to be automatically uncompressed by a BrightSign player prior to execution.

The autozip.brs script unpacks  script should unpack the contents of the autorun.zip file to an installed storage device and reboots reboot to complete the update:

Code Block
titleExample
package = CreateObject("roBrightPackage", "SD:/autorun.zip")
package.Unpack("SD:/")
MoveFile("SD:/autorun.zip", "SD:/autorun.zip_invalid")
RebootSystem()

Unpacking Encrypted Archives

If the autorun.zip file is encrypted, then the player uses the password stored in the registry, in the section "security" under the name "autozipkey," to decrypt the file.

 

...

 

Code Block
titleExtended Example
' Content update application


r=CreateObject("roRectangle", 20, 668, 1240, 80)
t=CreateObject("roTextWidget",r,1,2,1)
r=CreateObject("roRectangle", 20, 20, 1200, 40)
t.SetSafeTextRegion(r)
t.SetForegroundColor(&hff303030)
t.SetBackgroundColor(&hffffffff)
t.PushString("Updating content from USB drive, please wait...")


package = CreateObject("roBrightPackage", "autorun.zip")
package.SetPassword("test")
package.Unpack("SD:/")
package = 0


t.Clear()
t.PushString("Update complete - remove USB drive to restart.")


while true
       sleep(1000)


       usb_key = CreateObject("roReadFile", "USB1:/autorun.zip")
       if type(usb_key) <> "roReadFile" then
             a=RebootSystem()
       endif
       usb_key = 0
end while

...