This Quick Start Guide will help you create a Voice meta file for a SmartThings device, for a single Voice intent. Specifically, you will use the example "Send a command to a SmartThings device", for which you will create an action flow for the Voice command "Switch on the Light".
Launch Bixby Home Studio in your browser by visiting https://bhs.bixbydevelopers.com.
If you're not logged in, you will be prompted to sign into your Samsung Account.
Bixby Home Studio displays the Settings window.
If this page does not open by default, click on the Settings icon in the sidebar:
Here is how you configure BHS for your device:
If you are an internal user, you can also select the server that your devices are connected to.
Since you haven't created a Bixby Home Studio Project yet, you will be prompted to do one of the following:
Click the New Project button. In the future, you can use the first three toolbar buttons to create, download, or import new projects.
The next screen will prompt you to fill in the project's device and metadata information.
You'll need to fill in the following information:
You can edit the metadata after the project is created by clicking on the BHS Metadata icon in the sidebar to the left of the screen.
You can also choose how to create the initial metadata:
For the lightbulb example, select the first choice, then click NEXT.
Now you will be prompted to select voice commands from the selected device's existing capabilities. These voice commands are used to control the project's device.
If you had chosen "Create metadata from scratch", you would have to choose a Bixby Voice Category first. This would pull up all the related SmartThings device commands that are supported. Choosing the "Create metadata using SmartThings capabilities of the device" option helps narrow down the available commands for you to work with.
Select the voice commands you want to add to the project, then click NEXT. You are now shown the project summary screen. You can add the project name here.
Bixby Home Studio will now display its main editor screen, with the Voice Intent you added displayed in the Voice Intent section of the sidebar. Expand the voice intent to see the Property and Graph links.
For more information about the editor screen and how to add more voice intents, read How to Use the Bixby Home Studio Editor.
By associating a voice intent with an action flow, you are specifying what action the device should perform for that voice intent.
Here is how to create an action flow:
powerswitch-turnon
voice intent.Start
node from the Node menu to the flow editor area. The Start
node is triggered when the user utters a command. This command is the trigger for any action flow.Command
node to the flow editor area to send a command to the device.Start
node trigger the Command
node, connect the output trigger of Start
node to the trigger port of the Command
node.Click on the Command
node to select it.
Click on APPEND NEW ITEM to add a command.
Select main
as the component, if not yet selected.
Select the command capability from the dropdown of the Node Configuration menu. The example uses switch
.
Select a command for the selected capability and click the SAVE button to save this selection.
You have now created an action flow that sends a Switch on
command to the light bulb.
Response: Success
and Response: Execution Failed
nodes to the flow editor area. This feature lets users know about their device connection statuses. You do this by connecting the output ports from the Command
node to the respective Response:
nodes.Command
to the Response: Success
node. Response: Execution Failed
node.You can use the Try it feature of the editor to test if the action flow works as intended on a real device. To test, click on the Try it button in the menu bar.
Turn off your device and click on Try It. You will see that your device is switched ON
. You can see the green flowing line over the execution path as shown below. Any obtained values, responses etc. are shown below the corresponding nodes.
You have now successfully created and tested an action flow for a voice intent! Similarly, you can add action flows for more voice intents that you want to include in the voice meta information. The action flow created in this tutorial is simple, but you can always add multiple nodes to create a more complex action flow.
Bixby Home Studio has more capabilities than what is covered in this Quick Start Guide. For more details, see the How to Use the Bixby Home Studio Editor guide and all the other Developers' Guides for Bixby Home Studio.