Assigning Tasks to Buttons, Labels, and Timers
You can assign a list of one or more tasks to each button, label, or timer. When the user clicks a label or button, the associated tasks are performed. When a timer reaches its threshold value (repeat rate), its associated tasks are performed.
Note: For labels or buttons, you can also trigger task lists externally, through keyboard shortcuts or RossTalk messages. For more information, see Triggering Tasks Externally.
The types of tasks you can assign include the following:
•ogScript — runs a segment of ogScript code. You can also use the provided ogScript editor to parse XML data.
•RossTalk Script — sends a RossTalk command to a specific device to perform a task. Devices include Carbonite and Acuity production switchers, and XPression graphics systems.
For more information about the RossTalk protocol, see the document, RossTalk-Commands (4802DR-403).
•CamBot — sends a command to a specific Ross Robotics CamBot™ device to perform a task.
•VDCP Command — sends a VDCP command to a Ross BlackStorm Video Server, to perform a task.
•PBus Command — sends a PBus command to XPression, or to another device that uses the PBus protocol.
•Timer Control — performs a timer function, such as count up/down and stop.
•Data Modification — modifies parameter values as specified.
This section describes how to assign tasks, and includes the following topics:
•Assigning Data Modification Tasks
•Assigning Timer Control Tasks
ogScript is a programming language developed by Ross Video to interact with DashBoard-enabled devices. It is a subset of JavaScript, with additional PanelBuilder-specific functions added.
You can add advanced functionality and logic to CustomPanels by creating tasks that execute ogScript code. Tasks can be associated with buttons, labels, parameters, timers, and listeners.
You can create and edit ogScript code manually, or use the Visual Logic editor to create and edit ogScript code visually.
For more information about using ogScript in CustomPanels, see Working with ogScript.
To assign an ogScript task:
1.Create the item with which you want to associate the task.
Tasks can be associated with buttons, labels, parameters, timers, and listeners.
2.In Edit Mode, double-click the item, to open the Edit Component window.
3.In the Component Tree, navigate to the item.
4.In the attribute editor area, open the Attributes tab for the item.
The Attributes tab will be one of the following: Button Attributes, Label Attributes, Param Attributes, Timer Attributes, or Listener Attributes.
5.In the Tasks area, click Add.
The Add Task dialog appears.
6.In the Task Type area, click the ogScript button.
7.Do one of the following:
•If you want to create the ogScript code manually, click the ogScript button, and then type or paste the ogScript code into the ogScript editor.
For detailed reference information about ogScript functions, see the DashBoard CustomPanel Development Guide (8351DR-007).
•If you want to create the ogScript code visually, click the Visual button, and then add and connect logic blocks to create the code.
For more information about the Visual Logic editor, see DashBoard Visual Logic
The ogScript task is added to the Tasks list.
9.When you are finished creating the task, click Apply Changes or Apply and Close.
You can add timed pauses between tasks in a task list.
To add a pause to a task list:
1.Open a timer or control that includes a task list.
2.In the Tasks area, click the task that you want the pause to follow.
3.Click Add.
The Add Task dialog appears.
4.In the Task Type area, click the Pause button.
The Pause Editor dialog appears.
5.Specify the duration of the pause.
Tip: You can specify the unit of measure in time units (milliseconds, seconds, minutes), or frames (at 24 fps, 25 fps, 30 fps, 50 fps, or 60 fps).
Important Note: Pauses are run on the DashBoard computer and will not be frame accurate. They will roughly be of the duration specified.
6.Click OK.
The pause is added to the Tasks list.
RossTalk is an Ethernet-based protocol that allows the control of Ross Video devices using simple commands. Refer to the documentation that came with your device to verify which commands it supports.
In PanelBuilder, you can create tasks that send RossTalk commands. For more information about the RossTalk protocol, see the document RossTalk-Commands (4802DR-403).
You can associate commands with buttons, labels, parameters, timers, or listeners.
To assign a RossTalk command:
1.Create the item with which you want to associate the command.
2.In edit mode, double-click the panel, to open the Edit Component window.
3.In the component tree, navigate to the item.
4.In the attribute editor area, open the Attributes tab for the item.
Tip: The Attributes tab will be one of the following: Button Attributes, Label Attributes, Param Attributes, Timer Attributes, or Listener Attributes.
5.In the Tasks area, click Add.
The Add Task dialog appears.
6.In the Task Type area, click the RossTalk button.
The RossTalk Editor dialog appears.
7.Configure the connection to the device. This is the device to which the command will be sent when the task runs. Do one of the following:
•Specify the Host IP address and Port number of the device.
The default port for RossTalk commands is port 7788.
•Select a connection from the Connection list. For information on adding connections to the Connection list, refer to the section "Using the Global List".
8.In the Command list, double-click the command you want to send.
Tip: The Command list shows all commands. Some may not be applicable to the device you are controlling.
Tip: The Command box is yellow until you provide the IP address of the device (see step 7. ).
9.If additional command parameter boxes appear below the Command box, specify parameter values as required.
10.In the Callback Function area, type any commands to be executed after the RossTalk command is completed.
Note: Commands that accept a callback do so because they run asynchronously. Callback commands are not guaranteed to execute before the next task. They are cued and run as soon as possible.
11.Click OK to apply your changes and to close the Add Task dialog.
12.Click Apply Changes or Apply and Close.
This section describes how to assign CamBot commands. You can associate commands with buttons, labels, parameters, timers, or listeners.
To assign a CamBot command:
1.Create the item with which you want to associate the command.
2.In edit mode, double-click the panel, to open the Edit Component window.
3.In the component tree, navigate to the item.
4.In the attribute editor area, open the Attributes tab for the item.
Tip: The Attributes tab will be one of the following: Button Attributes, Label Attributes, Param Attributes, Timer Attributes, or Listener Attributes.
5.In the Tasks area, click Add.
The Add Task dialog appears.
6.In the Task Type area, click the CamBot button.
The CamBot Editor dialog appears.
7.Configure the connection to the CamBot control computer. This is the CamBot control computer to which the command will be sent when the task runs. Do one of the following:
•Specify the Host IP address and Port number of the CamBot control computer.
The default port number is 2050.
•Select a connection from the Connection list. For information on adding connections to the Connection list, refer to the section "Using the Global List".
8.In the Command list, double-click the command you want to send.
Tip: The Command box is yellow until you provide the IP address of the device (see step 7. ).
9.If additional command parameter boxes appear below the Command box, specify parameter values as required.
10.In the Callback Function area, type any commands to be executed after the CamBot command is completed.
Note: Commands that accept a callback do so because they run asynchronously. Callback commands are not guaranteed to execute before the next task. They are cued and run as soon as possible.
11.Click OK to apply your changes and to close the Add Task dialog.
12.Click Apply Changes or Apply and Close.
This section describes how to send Video Disk Control Protocol (VDCP) commands from DashBoard to your Ross BlackStorm Video Server.
You can associate commands with buttons, labels, parameters, timers, or listeners.
To assign a VDCP command:
1.Create the item with which you want to associate the command.
2.In edit mode, double-click the panel, to open the Edit Component window.
3.In the component tree, navigate to the item.
4.In the attribute editor area, open the Attributes tab for the item.
Tip: The Attributes tab will be one of the following: Button Attributes, Label Attributes, Param Attributes, Timer Attributes, or Listener Attributes.
5.In the Tasks area, click Add.
The Add Task dialog appears.
6.In the Task Type area, click the VDCP button.
The VDCP Editor dialog appears.
7.Configure the connection to the device. This is the device to which the command will be sent when the task runs. Do one of the following:
•Specify the Host IP address and Port number of the device.
•Select a connection from the Connection list. For information on adding connections to the Connection list, refer to the section "Using the Global List".
8.In the Command list, double-click the command you want to send.
Tip: The Command list shows all commands. Some may not be applicable to the device you are controlling.
9.Tip: The Command box is yellow until you provide the IP address of the device (see step 7. ).
10.If additional command parameter boxes appear below the Command box, specify parameter values as required.
11.In the Callback Function area, type any commands to be executed after the VDCP command is completed.
Note: Commands that accept a callback do so because they run asynchronously. Callback commands are not guaranteed to execute before the next task. They are cued and run as soon as possible.
12.Click OK to apply your changes and to close the Add Task dialog.
13.Click Apply Changes or Apply and Close.
This section describes how to assign Peripheral BUS (PBUS) commands. You can send PBUS commands to control Ross Video XPression and other PBUS-enabled devices.
For detailed information about using PBUS with XPression, see the document, PBus on XPression.pdf, which is available on your XPression system in the C:\archives directory.
You can associate commands with buttons, labels, parameters, timers, or listeners.
To assign a PBUS command:
1.Create the item with which you want to associate the command.
2.In edit mode, double-click the panel, to open the Edit Component window.
3.In the component tree, navigate to the item.
4.In the attribute editor area, open the Attributes tab for the item.
Tip: The Attributes tab will be one of the following: Button Attributes, Label Attributes, Param Attributes, Timer Attributes, or Listener Attributes.
5.In the Tasks area, click Add.
The Add Task dialog appears.
6.In the Task Type area, click the PBus button.
The PBus Editor dialog appears.
7.Configure the connection to the device. This is the device to which the command will be sent when the task runs. Do one of the following:
•Specify the Host IP address and Port number of the device.
•Select a connection from the Connection list. For information on adding connections to the Connection list, refer to the section "Using the Global List".
8.In the Device list, select the device to which you want to send the command.
9.In the Command list, double-click the command you want to send:
•Learn — Commands the device to capture and store its current status. The device normally stores whatever data it requires to return to its current state.
•Recall — Commands the device to return to a previously-stored state.
•Trigger — Commands the device to execute an event which has been previously prepared. For example, data for a credit crawl can be read in advance, and then the trigger command executes the credit crawl.
Tip: The Command box is yellow until you provide the IP address of the device.
10.In the Register list, type the register number, which is used as an identifier for the learned status. The register is specified when learning the status and for recalling the status.
11.In the Callback Function area, type any commands to be executed after the PBUS command is completed.
Note: Commands that accept a callback do so because they run asynchronously. Callback commands are not guaranteed to execute before the next task. They are cued and run as soon as possible.
12.Click OK to apply your changes and to close the Add Task dialog.
13.Click Apply Changes or Apply and Close.
The Global List allows you to add a device connection to a list that enables easy association of commands with a similar device that uses a different IP address. This is helpful if you have multiple networks of devices or if you are moving around from different locations with a custom panel.
To add a device connection to the Global List:
1.Open the Edit Component dialog for a component (button, label, parameter, or listener).
2.Select the associated Attributes tab.
3.Click Add.
The Add Task dialog opens.
4.Specify the Host IP address and Port number of the device.
5.Click the Add Host/Port To Global List button.
The Input dialog opens.
6.Type a name for the host/port and click OK.
The host/port appears in the Connection list.
To assign a device connection using the global list:
1.Open the Edit Component dialog for a a component (button, label, parameter, or listener).
1.Select the associated Attributes tab.
2.Click Edit.
The Edit Task dialog opens.
3.Select a host/name from the Connection list.
4.Click OK.
Assigning Data Modification Tasks
You can create a task that modifies parameter values.
For More Information on...
•parameters, refer to the section, Parameters and Data Sources.
You can associate tasks with buttons, labels, parameters, timers, or listeners.
To assign a data modification task:
1.Create the item with which you want to associate the task.
2.In edit mode, double-click the panel, to open the Edit Component window.
3.In the component tree, navigate to the item.
4.In the attribute editor area, open the Attributes tab for the item.
Tip: The Attributes tab will be one of the following: Button Attributes, Label Attributes, Param Attributes, Timer Attributes, or Listener Attributes.
5.In the Tasks area, click Add.
The Add Task dialog appears.
6.In the Task Type area, click the Data Modification button.
The Data Modification Editor dialog appears.
7.In the list of parameters, select the parameter that the task will modify.
8.Choose to either set the parameter to a specific value or to increment / decrement it by a specific amount whenever the user selects it on the CustomPanel. Choose from the following:
•Set to value — Specifies the value of the parameter value.
•Increment/Decrement Value — Increases the parameter value by the specified value. To decrement the parameter value, specify a negative value.
•Set to event property — Changes the parameter to the specified state.
•Set to script — Allows you to modify the parameter value through a small piece of ogScript.
For example, to set the parameter's value to the value of parameter 0x02 subtracted from parameter 0x01, you would type params.getValue(0x01, 0) - params.getValue(0x02).
9.Click OK to apply your changes and close the Add Task dialog.
10.Click Apply Changes or Apply and Close.
This section describes how to assign tasks to a timer.
1.Create the timer, as described in the section, To create a timer:.
2.On the Edit Mode toolbar, click the Timers button.
The Add/Edit Timers dialog appears.
Tip: The Add/Edit Timers dialog lists all the timers associated with the current CustomPanel.
3.In the list of timers, click the timer to which you want to assign a task.
The Timer Properties area shows settings for the timer. The Tasks area shows all task currently assigned to the timer. Some tasks are automatically created
4.In the Repeat Rate boxes, specify how often the list of tasks is to be performed.
5.In the Tasks area, click the Add button.
The Add Task dialog appears.
6.In the Task Type area, click the type of task you want to associate with the timer.
The Editor area updates according to the task type you selected.
7.Define the task using the Editor area of the Add Task dialog.
For more information about defining the task, see one of the following:
›For ogScript tasks, see Steps 5 to 8 in Assigning ogScript Tasks
›For RossTalk tasks, see Steps 5 to 12 in Assigning RossTalk Commands
›For CamBot tasks, see Steps 5 to 12 in Assigning CamBot Commands
›For VDCP tasks, see Steps 5 to 13 in Assigning VDCP Commands
›For PBus commands, see Steps 5 to 13 in Assigning PBUS Commands
›For data modification tasks, see Steps 5 to 10 in Assigning Data Modification Tasks
8. In the Add/Edit Timers dialog, click Commit Changes, and then click Done.
You can edit any task, change the order that tasks are performed. Each time the task control is activated, all tasks on the list are performed, in the order in which they are listed.
To edit a task
1.Display the Edit Component dialog for your component.
2.Select the Attributes tab.
3.In the Tasks area, select the task you want to edit.
4.Click Edit to display the Edit Task dialog.
5.Use the provided menus to update the task.
6.Click OK to save your changes.
7.Click Apply Changes or Apply and Close.
To arrange the task order:
1.Display the Edit Component dialog for your component.
2.Select the Attributes tab.
3.Select tasks and arrange them in the order you want them to be performed. One task is performed each time the task control is activated. You can arrange tasks as follows:
•First — move the selected task to the top of the task list.
•Move Up — move the selected task up one on the task list.
•Move Down — move the selected task down one on the task list
•Last — move the selected task to the bottom of the task list.
4.Click Apply Changes or Apply and Close.
To delete a task
1.Display the Edit Component dialog for your component.
2.Select the Attributes tab.
3.In the Tasks area, select the task you want to delete.
4.Click Delete to remove the task from the list.
5.Click Apply Changes or Apply and Close.