Skip to content
This repository has been archived by the owner on Sep 20, 2018. It is now read-only.

brightsign/dinerware-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

##Overview

This tech note details how to integrate your digital menu board presentations in BrightAuthor with the Dinerware online database. For more information about creating and publishing presentations, please see the BrightAuthor User Guide.

An example presentation that uses this plugin can be found here: ftp://ftp.brightsignnetwork.com/download/dinerware/examples/dinerware-example-1.0.zip

###Creating a Set of User Variables

First, you will need to create a number of User Variables in BrightAuthor. These variables will allow you to access the Dinerware database and display menu items, prices, and descriptions. To create User Variables in a presentation, navigate to File > Presentation Properties > Variables and click the Add Variable button.

The following User Variables need a Default Value along with the Name:

  • brain_url: Enter the IP address of the Dinerware host computer.
  • numPresentationMenuItems: Enter the total number of menu items displayed in the presentation. This number includes all items, even if some of the items are only displayed at certain times.

The following User Variables only need to have a correct Name. You can enter any arbitrary value in the Default Value field because it will be automatically retrieved from the Dinerware server by the plugin. The “X” in each of these variables represents the menu item number: For example, “ItemX_name” represents “Item1_name”, “Item2_name”, “Item3_name”, and so on.

  • ItemX_name: The name of the menu item.
  • ItemX_price: The price of the menu item.
  • ItemX_desc: A description of the menu item.

###Adding the Dinerware Plugin

Next, you need to add the Dinerware plugin to your presentation:

  1. Navigate to File > Presentation Properties > Autorun.
  2. Click the Add Script Plugin button.
  3. Enter “dinerware” in the Name field.
  4. Click the Browse button. Locate and select the dinerware_plugin.brs/em> file.

###Adding Items to your Menu Board

You will need to use a Live Text state to display the Dinerware menu items on your digital menu board:

  1. Click the interactive option to the right of the playlist to make the presentation interactive.
  2. Select the other tab in the Media Library section.
  3. Drag and drop the Live Text icon onto the playlist area.
  4. Enter a State name and specify a Background Image for the menu board.
  5. Change the type of the text box to User Variable and select a variable for the first menu item.
  6. Click the Add Item button to create text boxes for additional items, prices and descriptions.

###Setting a Refresh Timer

The Dinerware plugin should regularly refresh the contents of the menu board (i.e. the User Variables). The easiest way to accomplish this is to add a Send UDP command to a Timer event:

  1. Select the events tab in the Media Library section.
  2. Drag and drop the Timer event icon onto the Live Text state you created in the previous section.
  3. In the Specify timeout field, specify an update interval in seconds. We recommend specifying an update interval of 15 seconds or greater to avoid placing too much strain on your networking infrastructure.
  4. Set the transition to Remain on current state.
  5. Select the Advanced tab while in the Timeout Event window.
  6. Click the Add Command button.
  7. Select the Send > UDP command. In the Command Parameters field, enter “dinerware!getmenu”.

You can also set updates to occur upon other interactive events (UDP Input, Keyboard Input, Rectangular Touch, etc.). Simply add the desired event to the Live Text state and follow steps 4-7 above.

Releases

No releases published

Packages

No packages published