Introduction to Sample Graphs

What Are Sample Graphs

Sample graphs are various example action flows you can explore to learn more about the various voice intents, nodes, and SmartThings capabilities available in Bixby Home Platform. Additionally, you can use these sample graphs as starter points for your own devices!

Each sample graph is meant to generically handle specific capabilities covered under various user utterances through the various voice intents. For example, the Turn On Device sample graph will work for any device and covers a variety of user utterances such as "Turn on air conditioner", "Turn on fan", "Turn on speaker", and so on. This way, you can find the general use case that you need and not have to worry about it being tied to a specific device.

Note

Check the SmartThings Capabilities reference for the various voice commands that are supported for each capability.

Copying the Graphs from the Bixby Developer Center

If you decide to use a graph, you can copy the graph information as JSON and paste it directly into Bixby Home Studio (BHS):

  1. Navigate to the sample graph you'd like to use.
  2. Click the Copy button on the bottom right corner of the graph. This copies the sample graph information to your clipboard. Copy button outlined on a sample graph
  3. Open BHS.
  4. If you haven't already, set up a new voice intent under the Metadata profile of your device. (For more information, see How to Use the Editor).
  5. Navigate to the voice intent where you want to add the graph.
  6. Click on the Graph link under that voice intent. Graph Link selected in Voice Intents panel
  7. Click the JSON button in the upper right corner of the editor. JSON button outlined in editor window of BHS
  8. Paste the sample graph into the Load Graph JSON window. Example of Load Graph JSON window with "Play the Next Song on the Device" sample graph
  9. Click Import. This imports the JSON file into BHS and loads it as a graph into your own metadata file.

Now you have a graph you can use in your own metadata! You can modify the graph as needed as well.

"Play the Next Song on the Device" sample graph being used in BHS

Using the Graphs Within Bixby Home Studio

You can also use the sample graphs that are directly integrated in BHS.

To view the various sample graphs, click the Sample Graphs button in the left sidebar menu.

If you want to use one of the sample graphs:

  1. If you haven't already, set up a new voice intent under the Metadata profile of your device. (For more information, see How to Use the Editor).
  2. Navigate to the voice intent where you want to add the graph.
  3. Click on the Graph link under that voice intent. Graph Link selected in Voice Intents panel
  4. Click the Sample Graphs button in the left sidebar menu to show all the available sample graphs. BHS with the Sample Graphs tab open
  5. Find the sample graph you want to use. You can either scroll through the sample graphs or filter the results by searching for the specific graph in the search bar: Filtering Sample Graphs by searching
  6. Drag and drop the sample to the Editor pane. Filtering Sample Graphs by searching

Once the graph has been added, the editor will inform you that the nodes were imported.

Your graph is now ready to use as-is or modify for your needs!