Bixby Developer Center

This guide assumes familiarity with the following information:

• The basics of the editor (How to Use Bixby Home Studio)
• The Command Node (Sending a Device Command)

In this guide, you'll learn how to send a command to the device with an argument. The device used in this guide is a SmartThings-enabled TV. You'll also be introduced to the Utterance Parameter Node.

Take the example "Set the #{Device} volume to 75". The goal is to define the action flow for this voice intent, which will set the volume level of a TV to a user-supplied value.

Utterance Parameter Node

For this voice intent, the user must give Bixby an integer value between 0 and 100:

Example: "Set the #{Device} volume to 75."

This parameter value gets passed down to the Utterance Parameter Node. This node stores the value of the specified parameter, which is captured from a user utterance.

In Bixby Home Studio (BHS), you can configure the Utterance Parameter Node with a default value. Normally, a device would get the input value from a user's utterance. For testing purposes in this guide, you can use a default value, which allows you to test the action flow on a device without an actual user utterance.

Start building your action flow by dragging the Start and Utterance Parameter nodes from the action flow nodes sidebar to the editor area. Then, configure the Utterance Parameter Node:

1. Click the Utterance Parameter Node. This opens the Node Configuration menu on the right of the editor area.
2. In the data type menu, select volumeLevel (integer). This sets the node parameter type to integer.
3. Below your data type selection, enter an integer between 0 and 100 in the defaultValue field.

Sending a Command

Now, you need to send a command to the device to set the volume level of the TV to the user's uttered value.

Drag a Command Node to the flow editor area. Then, click the node to open the Node Configuration menu on the right. Click APPEND NEW ITEM.

Select main in the component menu. Then, select the audioVolume command in the capability menu.

A pop-up for audioVolume opens. Select the setVolume command, which will add input ports for volume level to the Command Node. Then, click SAVE.

The Command Node should now have input ports for device and 1:volume. Since device is an optional argument, you can ignore it for now to keep things simple. The 1:volume input determines the volume level value for this device. The prefix 1: in front of the volume is the sequence number of each command added in the configuration screen of the Command Node.

The 1:volume input port is an example of a dynamic input port. Dynamic input ports can be added to a node and their labels can change based on a node's capability. In this case, the number of dynamic input ports and their labels depend on the capability of the Command Node.

Now you need to connect a data path from the Utterance Parameter Node's value data port to the Command Node's 1:volume data port. You also need to connect the Start Node to the Command Node's input trigger port.

Here's the finished action path:

Testing Your Action Flow

To test the action flow, click the Try It button at the top right of the editor window. The flow editor should look like this:

The value of the Utterance Parameter Node has been set to 75, and this is used as the mock utterance value. That value is then used to set the volume value for the voice command "Set the #{Device} volume to 75".

You will also see a warning icon on the Command Node. When you hover over it, a message states that a response was not generated. This is because there is no Response Node in the action flow.

Additional Resources

This guide creates a simple action flow, but you can create action flows of your own with the various nodes and capabilities available to the device you are using.

You can also make more complex graphs by using subgraphs.

For an additional example, see the "Set the Volume of the Device to a Value" Sample Graph.