Quick Start Guide

Ready to integrate Bixby intelligence with your SmartThings device? Follow this Quick Start Guide to get started.

This guide shows you the basics of Bixby Home Studio (BHS). You'll learn how to:

  • Launch the BHS editor to start building a logical action flow.
  • Configure BHS settings.
  • Create a new project and initial Voice metadata file for a SmartThings device for a single voice intent.
  • Test your action flow in the BHS editor.

Let's get started and equip your device with Bixby intelligence! Specifically, you'll use the example "Send a command to a SmartThings device" to create an action flow for the Voice command "Switch on the light." Once you've followed these steps, Bixby should be able to turn on the light with the Voice command "Switch on the light."

Launch the Editor

Launch BHS in your browser by visiting https://bhs.bixbydevelopers.com.

BHS displays the Settings window. If you're not already logged in to your Samsung Account, you'll receive a prompt to sign in.

BHP settings

Configure BHS Settings

If BHS doesn't open the Settings window by default, click on the Settings icon in the sidebar on the left.

Settings Icon in BHS

Here's how you configure BHS for your device:

  1. Select the preferred language for testing purposes under Hints/Dialogue Language.
  2. Select the maximum number of backups for metadata.
  3. Click on Save.

Create a New Project

Since you haven't created a BHS Project yet, you'll be prompted to do one of the following:

  • Create a new project.
  • Download existing Bixby Home Platform (BHP) metadata for a project.
  • Import a JSON metadata file from your local computer.

Click the New Project button. In the future, you can use the first three toolbar buttons on the top to create, download, or import new projects.

Create a New Project Button

The next screen prompts you to fill in the project's device and metadata information.

New Project Info Screen

Fill in the following information:

  • SmartThings Location: The location of the device you want to control, as configured in SmartThings.
  • SmartThings Device: The device you want to control, as configured in SmartThings.

Choose how to create the initial metadata from these options:

  • Create metadata using SmartThings capabilities of the device. Choose this option if your device already supports existing SmartThings capabilities.
  • Create metadata from scratch. Choose this option if you want to create all of your own metadata.
  • Update from existing metadata. Choose this option if you're working with other people, so you can download an existing metadata file.

For the lightbulb example, select the first choice. Then click NEXT.

Note

You can edit the metadata after the project is created, by clicking on the BHS Metadata icon in the left sidebar.

Select a Voice Intent

Now you're prompted to select voice intents from the selected device's existing capabilities. Voice intents are a set of user's intentions that Bixby can understand from natural voice commands. Different capabilities support various voice intents.

For more information on voice intents, see the Voice Intents reference page.

Select the Voice Command

Note

If you select "Create metadata from scratch," you have to choose a Bixby Voice Category first. This pulls up all the related SmartThings device commands that are supported. Choosing "Create metadata using SmartThings capabilities of the device" helps narrow down the available commands you can work with.

Select the voice commands you want to add to the project. Voice commands control the project's device. For this example, choose the "Turn on #{Device}" voice command. Then click NEXT. You can now view the Review Project Summary screen.

Add the project name and click DONE.

Create new project

BHS now displays its main editor screen with the voice intents you added, displayed in the Voice Intents section of the left sidebar.

BHS main editor screen

Expand the voice intents to see the Property and Graph links.

Added voice intents

For more information about the editor screen and how to add more voice intents, read How to Use the Bixby Home Studio Editor.

Create an Action Flow

To specify what action the device should perform for a voice intent, you need to associate the voice intent with an action flow. An action flow is a graph consisting of linked Nodes of different types that create a logical sequence of actions. Nodes are the functions that developers can use in BHS.

A Node consists of the following components:

  • Configuration describes how the Node is set up.
  • Data input/output ports transfer information into and out of a Node.
  • Triggering ports are the Node ports that receive or send execution flows.

Diagram of a node in Bixby Home Studio

For more information, see the Nodes reference page.

Build an Action Flow

Follow these steps to create a logical action flow for a specific voice intent for the device.

Place the Start and Command Nodes

A Start node triggers an action flow. The user triggers the Start node by uttering a relevant command. The Command node sends a command to the device.

  1. If you haven't already, click on the Graph link under the chosen voice intent. For this example, click on Graph under the powerswitch-turnon voice intent.
  2. Drag and drop the Start node from the Node menu to the flow editor area.
  3. Drag and drop the Command node to the flow editor area.
  4. Connect the output trigger of the Start node to the trigger port of the Command node. This allows the Start node to trigger the Command node.

Trigger command node

Set the Execution Command
  1. Click on the Command node to select it.

  2. Click on APPEND NEW ITEM to add a command.

Command node configuration

  1. Select main as the component, if not yet selected.

  2. Select the command capability from the dropdown of the Node Configuration menu. For this example, choose switch.

Select switch capability

  1. Select a command for the selected capability and click SAVE. For this example, use the command on.

Select Switch on command

You have now created an action flow that sends a Switch on command to the light bulb.

Generate Responses

Response nodes inform users about the success or failure of the device commands.

  1. Drag and drop the Response: Success and Response: Execution Failed nodes to the flow editor area.
  2. Connect the success output port of the Command node to the trigger port of the Response: Success node.
  3. Connect the failure output port of the Command node to the trigger port of the Response: Execution Failed node.

Action flow with responses

Test in the Editor

Use the Try it feature of the editor to test if the action flow works as intended on a real device. Make sure your device is turned off. Then click on the Try it button in the menu bar at the top.

Try It button

You should see a confirmation 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.

Execution flow

Next Steps

You've now successfully created and tested an action flow for a voice intent! The action flow created for this tutorial is simple, but you can choose to add additional Nodes to create a more complex action flow. You can also add action flows for additional voice intents that you want to include in the Voice meta information.

To take a deeper dive into BHS capabilties, read the various Developers' Guides for BHS.


Video Tutorial: Bixby Home Studio Quick Start Guide