Example: Using custom Boolean variables in an agent

Use the Programming view to create custom variables in an agent using a Boolean value.

In this example, when someone is at the door:

• Program to activate the Media Scene 'Someone is at the door,' and turn on the porch light.
• Program to play a song in the Bedroom and the Theater.
• When the Motion Sensor stops sensing motion at the door, program to turn the music and porch light off.

Prerequisites

The following devices are added and identified in the project:

• Controller
• Porch Light Switch
• Bedroom music
• Theater music
• Motion Sensor

To program using a custom Boolean variable in an agent:

1. Start Composer Pro and connect to a Director.

2. Click System Design.
3. Click Connections. Make sure the connections are correct. 

Note: Ensure that the Front Light is connected to the correct Contact Sensor on the controller. 

4. Click the Network tab, and ensure that the controller and Porch Light have a network address.

Create a new variable

5. Click Agents.
6. Select Variable. The Variables view appears.
7. Click New.
8. On the dialog that appears, do the following:

1. Click New Variable.

2. In the drop-down menu, select Boolean.

3. Name the Variable Power State and click OK. The default value is false.

Create a media scene ‘Someone is at the door’

9. Select Media Scenes, and click New.
10. Name the Media Scene Someone is at the door. Click OK.

Add the bedroom and theater room

11. Click Add Room, and add the Theater and the Bedroom (see above).

12. Set the volume in the Bedroom to 50, and the volume in the Theater to 75.

13. Click Programming.
14. In the project tree and the Device Events pane, click to expand Variables, and select Power State.
15. In the project tree and in the Device Actions pane, click to expand Variables, and select Power State.

Add the conditionals and commands

16. Follow the previous programming steps to create a script with Conditionals.
17. Click the Conditionals tab.
18. In the Conditionals tab, click Is False, and drag the blue question mark to the Script pane.

19. Click the Commands tab.
20. In the Commands tab, click Set to True, and drag the green arrow on top of the blue question mark in the Script pane to make it the first subset item of the first conditional.
21. In the Device Actions pane, select Light Switch.
22. Click the Commands tab.
23. In the Commands tab, click On, and drag the green arrow on top of the blue question mark in the Script pane to make it the second subset item of the first conditional.

24. In the project tree and in the Device Actions pane, select Media Scenes.
25. Click the Commands tab.
26. Click Activate in the Commands tab, and drag the green arrow on top of the blue question mark in the Script pane to make it third subset item of the first conditional.
27. In the project tree and in the Device Actions pane under Variables, select Power State.
28. Click the Conditionals tab.
29. In the Conditionals tab, click Is True, and drag the blue question mark to the Script pane.
30. Click the Commands tab.
31. In the Commands tab, click Set to False, and drag the green arrow on top of the blue question mark in the Script pane to make it the first subset item of the second conditional.
32. In the project tree and in the Device Actions pane, select Light Switch.
33. Click the Commands tab.
34. In the Commands tab, click Off, and drag the green arrow on top of the blue question mark in the Script pane to make it the second subset item of the second conditional.
35. In the project tree and in the Device Actions pane, select Media Scenes.
36. In the Commands tab, click Deactivate, and drag the green arrow on top of the blue question mark in the Script pane to make it the third subset item of the second conditional.

37. In the project tree and in the Device Events pane, select Media Scenes and select the event Someone is at the Door.
38. In the project tree and in the Device Actions pane, select the Bedroom object. (Repeat the next four steps for the Theater.)
39. Click the Commands tab.
40. In the Commands tab, click Select Media.

41. In the dialogue that appears, select the album and song that you want to play when Someone is at the Door executes. In this example, Rhapsody’s ‘50s Hits’ is used. Click OK.
42. Drag the green arrow to the Script pane.
43. Repeat steps 37-41 for the Theater.
44. In the project tree and in the Device Events pane, select Motion Sensor under Front, and select the event When the Motion Sensor senses motion.

Add the Boolean Values

45. In the project tree and in the Device Actions pane, click to expand Variables, and select Power State.
46. In the Conditionals tab, click Is False, and drag the blue question mark to the Script pane (this is the third conditional).
47. In the Commands tab, click Set to True, and drag the green arrow on top of the blue question mark to make it the first subset of the third conditional.
48. In the project tree and in the Device Events pane, select the event When the Motion Sensor stops sensing motion.
49. In the project tree and in the Device Actions pane, click to expand Variables, and select Power State.
50. In the Conditionals tab, click Is True, and drag the blue question mark to the Script pane.
51. In the Commands tab, click Set to False, and drag the green arrow on top of the blue question mark to make it the second subset of the third conditional.
52. Click Execute.

Results: The porch light turns on and plays a song in the bedroom and theater whenever the motion sensor senses motion at the front door.