Bixby Developer Center

Guides
References

On-Device Testing

Bixby Developer Studio includes a Simulator that lets you simulate your capsule's behavior on many devices. However, before submitting a capsule to the Marketplace, you should test your capsule on an actual Bixby device.

To test on a device, you'll need to:

  • Be registered with the Bixby Developer Center. For more information, see the Developer Console guide.
  • Make a private submission of a capsule to the Bixby Developer Center for testing.
  • Enable on-device testing on a compatible device.
Caution

While you can use on-device testing with a public submission, you should do all testing with a private submission until you are ready to submit your capsule to the Marketplace.

Check the Troubleshooting page if you have issues with on-device testing.

Testing a Capsule

To test a capsule on a device, the capsule must be prepared using your organization namespace and registered in the Bixby Developer Center. For more information about organization namespaces, creating or joining a team, and registering your capsules, see the Developer Console guide.

If you are testing one of the Sample Capsules, you need to change the id in the capsule.bxb file from example to your organization namespace.

You will only be testing your capsule from the specified submission on the specific device.

  1. In Bixby Studio, select Submissions (Cmd+8 / Ctrl+8) to open a submissions tab, then click Create New Submission.

  2. Set the submission type slider to Private. (You can read more about private versus public submissions here.)

  3. Choose the capsule you wish to submit from the list.

  4. Enter a description for the revision. The description will help you identify the revision you want to load later.

  5. Click Submit Capsule.

  6. After the submission is processed, open its entry in the Submission History list and copy down its revision ID. This will be a number like 2019-014-86348 or 2020-014-12053-release.

  7. Use this revision number in the Developer Options screen as described below in Enabling On-Device Testing.

Note

If you submit multiple capsules as part of your private submission, you will only be able to test each capsule on-device using named dispatch.

All utterances, even if they don't pertain to your capsule, will be directed to the capsules in the loaded private revision. Because of this, you might experience some training conflicts while testing, especially if you don't use named dispatch.

It's recommended to load a single capsule within a revision while doing on-device testing.

To stop testing a capsule, return to the on-device testing screen in Developer Options and disable testing on the device(s).

Note

Be aware that on-device testing allows you to test your specific capsule in isolation. It will not let you test for cross-capsule ambiguities and interactions. You are only testing your capsule on the specific device and revision that you have loaded. Plan to develop and test your capsule independently.

If you have a different revision you'd like to test, you can load the revision to your devices.

Enabling On-Device Testing

To enable on-device testing, you must be registered with the Bixby Developer Center. If you haven't registered with the Developer Center, create a Samsung Account first. (This is the same account you will use to log into Bixby Studio.) For more information about registering with the Bixby Developer Center, see the Developer Console guide.

Enable the Developer Options button in Bixby's settings. This is a hidden feature. To enable it, open Bixby, go to Bixby's Settings, and tap "About Bixby Voice." On the About screen, tap the Bixby version number five times. Bixby will inform you that developer options have been activated.

Bixby Developer Options activated

After activation, go back to the Bixby voice settings screen and tap the now-visible Developer Options. Tap On-device testing. You will be presented with a list of your Bixby-enabled devices that support on-device testing.

Note

Currently on-device testing is limited to the mobile device you are using. This limitation will be removed in a future release.

Device list

Enter the revision number of the private submission of your capsule.

Enter revision number

Bixby will prompt you with a Device Confirmation code. The selected device will give you the same Device Confirmation code as a notification. Tap Confirm to confirm the code.

Device confirmation

At this point, you will be prompted to log into the Samsung Developer Center. After logging in, Bixby will let you know the device has been connected.

Successful login

When you tap on a device enabled for On-Device Testing in the Developer Options device list, you'll see the currently loaded revision number, and have an option to enable or disable testing on that device.

Device enabled for testing

After on-device testing is enabled, you can return to the Bixby home screen and test utterances for your capsule.

Note

All utterances are routed to the capsules in the loaded private revision, even if they don't pertain to your capsule. For example, if you loaded a private revision for a dice capsule and ask Bixby "What's the weather?", Bixby will try to interpret the utterance with respect to your dice capsule.

To go back to using Bixby regularly, you need to disable on-device testing.