BrightSign Custom Plugin Management

Notes

• Host a .zip file containing the plugin files

• The plugin files should be prepared following this guide:

  1. Create the custom plugin directory called CustomScript

  2. Under the CustomScript directory, create a main.brs file

     Function CustomScript_Initialize(msgPort As Object, userVariables As Object, bsp as Object)
         LogCustomScriptMessage("CustomScript_Initialize - entry")
         return NewCustomScript(msgPort, userVariables, bsp)
     End Function
     
     Function NewCustomScript(msgPort As Object, userVariables As Object, bsp as Object)
         LogCustomScriptMessage(" @@@ CustomScript Plugin Appspace @@@ ")
         s = {}
         s.msgPort = msgPort
         s.userVariables = userVariables
         s.bsp = bsp
         s.ProcessEvent = CustomScript_ProcessEvent
         ' START OF CUSTOM SCRIPT ````````
         ' add your custom script here
         LogCustomScriptMessage("Sample custom script executed")
         ' END OF CUSTOM SCRIPT ``````````
         return s
     End Function
     
     Function CustomScript_ProcessEvent(event As Object) as boolean
         returnValue = false
         return returnValue
     End Function
     
     Sub LogCustomScriptMessage(message as string)
         customScriptSystemLog = createobject("roSystemLog")
         customScriptSystemLog.sendline("CustomScript|main.brs: " + message)
     End Sub

      

  3. Insert custom BrightScript logic only after the ' START OF CUSTOM SCRIPT marker and save the main.brs file.

  4. Add any other files in the CustomScript directory if necessary.

  5. To add additional plugins:

     • Repeat step 1 to 4 replacing CustomScript with a new plugin name (eg. SetupWiFi)

     • In step 2, replace all CustomScript code with the new plugin name (eg. SetupWiFi). The main.brs should look like:

       Function SetupWiFi_Initialize(msgPort As Object, userVariables As Object, bsp as Object)
           LogSetupWiFiMessage("SetupWiFi_Initialize - entry")
           return NewSetupWiFi(msgPort, userVariables, bsp)
       End Function
       
       Function NewSetupWiFi(msgPort As Object, userVariables As Object, bsp as Object)
           LogSetupWiFiMessage(" @@@ SetupWiFi Plugin Appspace @@@ ")
           s = {}
           s.msgPort = msgPort
           s.userVariables = userVariables
           s.bsp = bsp
           s.ProcessEvent = SetupWiFi_ProcessEvent
           ' START OF CUSTOM SCRIPT ````````
           ' add your custom script here
           LogSetupWiFiMessage("Sample custom script executed")
           ' END OF CUSTOM SCRIPT ``````````
           return s
       End Function
       
       Function SetupWiFi_ProcessEvent(event As Object) as boolean
           returnValue = false
           return returnValue
       End Function
       
       Sub LogSetupWiFiMessage(message as string)
           SetupWiFiSystemLog = createobject("roSystemLog")
           SetupWiFiSystemLog.sendline("SetupWiFi|main.brs: " + message)
       End Sub

  6. Zip the folders containing the plugin files. Please note that it’s important to zip the plugin folders as they will be used to determine the plugin name. When unzipped, the folder structure should look like this:

     

      

Note

BrightSign custom plugin device task templates are provided in the attached .zip file and can be imported into the Device Tasks extension.