Example: Using a custom string variable in an agent

Use the Programming view to create custom variables in an agent using a numeric value. The steps in this section are for more advanced users of Composer Pro. 

In this example, program Button 4 on a Keypad to toggle through four playlists. 

Note: This procedure is relatively complicated to create. Review the steps first to understand how the conditionals work.

Prerequisites

The following items are added and identified in the project:

• Controller
• 6-Button Keypad
• 4 Playlists: Mom’s Favorites, Dad's Favorites, Choral Music, and Kid’s Music

To program using a custom variable agent string:

1. Start Composer Pro and connect to a Director.

2. Click System Design. Make sure the project has the correct devices and rooms.
3. Click Connections. Make sure the connections are correct.

Note: In the Network tab, ensure that the controller and the 6-Button Keypad have an address.

Add a new variable

1. Click Agents.

2. Select Variables. The Variables agent list appears.
3. Click New.
4. On the dialog that appears, do the following:

3. Select New Variable, and name the variable My Playlists.

4. In Variable Type, use the pull-down menu to select String, and click OK.

Set up a ‘Mom's Favorites’ playlist in the theater

1. Click Programming.

2. In Programming select the 6 Button Keypad in the Theater from the Device Events pane.
3. In 6-Button Keypad Events, click Button 4 on the Keypad.
4. In the Device Actions pane, scroll down and click to expand Variables.
5. Select My Playlists.
6. In the My Playlists Actions pane, click the Conditionals tab, and enter the name of a playlist; for example, Mom’s Favorites.
7. Drag the first blue question mark to the Script pane.

8. In Device Actions, select the Theater room object.
9. In Theater Actions, select Select Media.
10. In the window that pops up, select Playlists, Mom’s Favorites, and then click OK.
11. Drag the green arrow icon on top of the first blue question mark in the Script pane to make it the first subset of the first conditional.

12. In Device Actions, select Variables > My Playlists.
13. In the Commands tab under My Playlists, enter the name of the next playlist that you’d like to play; for example, Dad’s Favorites.
14. Drag the green arrow on top of the first blue question mark to the Script pane to make it a second subset of the first conditional.

The next time the button on the keypad is pressed, the value of the variable will be Dad’s Favorites, and will then cue that playlist in the Theater.

15. In Device Actions, scroll up and select the 6 Button Keypad in the Theater.
16. In 6 Button Keypad Actions, click Button 4.
17. Under Color Settings select LED On.
18. Click the square of color to select the color you want Button 4’s LED to be when Mom’s Favorites plays. Select the color in the menu that pops up (in this example: green), and click OK.

19. Drag the green arrow on top of the first blue question mark in the Script pane to make it a third subset of the first conditional.

20. In Device Actions, scroll down and select Programming Control.
21. In the Programming Control Actions, select the Stop radio button.
22. Drag the green arrow on top of the first blue question mark in the Script pane to make it a fourth subset of the first conditional.

Note: It is important to add a Stop command here so that when the conditional is fulfilled, the programming will not continue. Because of the way this programming is set up when it’s finished, without the stop, the button on the Keypad will always select the last playlist in the script.

Set up a ‘Dad's Favorites’ playlist

1. In Device Actions, select My Playlists again.

2. In the Conditionals tab, next to ‘Is’ enter Dad’s Favorites in the text box.
3. Drag the second blue question mark to the Script pane.
4. In Device Actions, select the Theater.
5. In Theater Actions, select Select Media.
6. In the window that pops up, select Playlists, Dad’s Favorites, and then click OK.
7. Drag the green arrow on top of the second blue question mark in the Script pane to make it the first subset of the second conditional.

Set up a ‘Kid's Room’ playlist

1. In Device Actions, select My Playlists.

2. In the Commands tab under My Playlist Actions, enter the name of the next playlist that you’d like to play; for example, Kid’s Music.
3. Drag the green arrow on top of the second blue question mark in the Script pane to make it a second subset of the second conditional.
4. In Device Actions, select the 6 Button Keypad in the Theater.
5. In 6 Button Keypad Actions, click on Button 4. Click the square of color to select the color you want Button 4’s LED to be when Kid’s Music plays. Select the color in the menu that pops up (in this example: purple), and click OK.
6. Drag the green arrow on top of the second blue question mark in the Script pane to make it a third subset of the second conditional.
7. In Device Actions, select Programming Control.
8. In the Programming Control Actions pane, select Stop.
9. Drag the green arrow on top of the second blue question mark to make it a fourth subset of the second conditional.
10. In Device Actions, select My Playlists again.
11. In the Conditionals tab, enter Kid’s Music.
12. Drag the blue question mark to the Script pane to make it the third conditional.
13. In Device Actions, select the Theater room object.
14. In Theater Actions, select Select Media.
15. In the window that pops up, select Playlists, Kid’s Music, and then click OK.
16. Drag the green arrow on top of the third blue question mark in the Script pane to make it the first subset of the third conditional.

Set up a ‘Choral Music’ playlist

1. In Device Actions, select My Playlists.

2. In the Commands tab under My Playlists, enter the name of the next playlist that you’d like to play; for example, Choral Music.
3. Drag the green arrow on top of the third blue question mark to make it a second subset item of the third conditional.
4. In Device Actions, select the 6 Button Keypad in the Theater.
5. In 6 Button Keypad Actions, click on Button 4. Click the square of color to select the color you want button 4’s LED to be when Kid's Music plays. Select the color in the menu that pops up (in this example: red), and click OK.
6. Drag the green arrow on top of the third blue question mark in the Script pane to make it the third subset of the third conditional.
7. In Device Actions, select Programming Control.
8. In the Programming Control Actions, select the Stop radio button.
9. Drag the green arrow on top of the third blue question mark in the Script pane to make it a fourth subset of the third conditional.
10. In Device Actions, select My Playlists again.
11. In the Conditionals tab, enter Choral Music.
12. Drag the fourth blue question mark to the Script pane.
13. In Device Actions, select the Theater room object.
14. In Theater Actions, select the Select Media radio button.
15. In the window that pops up, select Playlists, Choral Music, and then click OK.
16. Drag the green arrow on top of the fourth blue question mark in the Script pane to make it the first subset of the fourth conditional.
17. In Device Actions, select My Playlists.
18. In the Commands tab under My Playlists, enter the name of the next playlist that you’d like to play; for example, Mom’s Favorites.
19. Drag the green arrow on top of the fourth blue question mark in the Script pane to make it a second subset of the fourth conditional.
20. In Device Actions, select the 6 Button Keypad in the Theater.
21. In 6 Button Keypad Actions, click on Button 4.
22. Click the square of color to select the color you want Button 4’s LED to be when Choral Music plays. Select the color in the menu that pops up (in this example: yellow), and click OK.
23. Drag the green arrow on top of the fourth blue question mark to make it a third subset of the fourth conditional.
24. In Device Actions, select Programming Control.
25. In the Programming Control Actions, select the Stop radio button.
26. Drag the green arrow on top of the fourth blue question mark to make it a fourth subset of the fourth conditional.
27. In Device Actions, select the Theater room.
28. In Theater Actions, select Media.
29. In the window that pops up, select Playlists, Mom’s Favorites, and then click OK.

Note: You do this is because the first time the button on the Keypad is pushed, the string variable does not have a value, and nothing happens. This last command is created when none of the conditionals are fulfilled, something will play; each time the button is pushed thereafter, a conditional is fulfilled.

30. Drag the green arrow below the previous Stop command in the Script pane. It is not a subset of the previous conditionals, but a command on its own.
31. In Device Actions, select My Playlists.
32. In the Commands tab under My Playlists, enter the name of the next playlist that you’d like to play; for example, Dad’s Favorites.
33. Drag the green arrow below the previous command in the Script pane.
34. In Device Actions, select the 6 Button Keypad in the Theater.
35. In 6 Button Keypad Actions, click on Button 4. Click the square of color to select the color you want Button 4’s LED to be when Mom’s Favorites plays. Select the color in the menu that pops up (in this example: green), and click OK.
36. Drag the green arrow below the previous command in the Script pane. You do not need a stop at this point, because the programming automatically stops at the end of the script.

Results: Press Button 4 on a 6-Button Keypad repeatedly to toggle through four playlists.