Bixby Developer Center

Guides

Bixby Developer Studio Basics

Downloading and Configuring Bixby Developer Studio

Bixby Developer Studio (Bixby Studio) is available for macOS and Windows. Download the installer from the link below and run it to install Bixby Studio.

Bixby Developer Studio has the following minimum hardware recommendations:

  • 1.6 GHz or faster CPU
  • 1 GB or more of RAM
  • Screen resolution of 1280×800

Bixby Developer Studio requires the following minimum OS versions:

  • Windows 8
  • macOS (OS X) 10.9
  • Linux:
    • Debian-based: Ubuntu Desktop 14.04, Debian 7
    • Red Hat-based: RHEL 7, CentOS 7, Fedora 23

After installation, you'll need to set up Bixby Studio.

  1. Launch Bixby Studio. On first launch, you will be asked to log in to the Bixby Developer Center.

  2. Before logging in, check the "Server" URL in the lower-left corner of the startup screen. You should see https://bixbydevelopers.com.

  3. Click Log In. Your browser will open and be directed to the Samsung Account login page.

  4. Enter your Samsung Account username and password.

  5. After logging in, the browser displays a "Login Successful" screen. Click Launch Bixby Studio. If your browser asks if you want to allow the page to launch Bixby Studio, click Allow.

Bixby Studio then connects to the Bixby server and sets up your workspace.

Note

Bixby Studio requires an internet connection for operation. There is no offline mode.

Bixby Developer Studio Tour

Bixby Studio follows design patterns you'll likely be familiar with if you've used other integrated development environments or code editors: a sidebar on the left, usually displaying a file/resource tree for your project, and a larger tabbed editor window to the right.

Bixby Developer Studio window

The main areas of Bixby Studio are indicated in the screenshot by numbers:

  1. Application Tabs
  2. Sidebar
  3. Editor
  4. Status Bar

Application Tabs

Bixby Studio's left margin displays six icons, two at the top and four at the bottom. The first two change the view in the sidebar (area 2), but don't affect the view in the editor (area 3).

Files (Cmd+1 / Ctrl+1): display your list of open capsules and all the associated files within the capsules, containing source code, assets, training, and other resources. This is the currently selected view in this screenshot. This is much like the project or explorer view in other IDEs. Click on any file to preview it within the editor, and double-click it to open it. (The Settings tab will allow you to change this behavior to opening files with a single click.)

Buttons at the top of the Files sidebar allow you to add files and capsules to your workspace and to manage currently open capsules.

Add to Workspace button

Add to Workspace has four options for adding capsules, folders, and files to the workspace:

  • Open Existing Capsule
  • Create Capsule
  • Create Folder (within the currently open capsule)
  • Create File (within the currently open capsule)

Manage Capsules button

Manage Capsules lets you manage the capsules currently open in the workspace:

  • Uncheck or check the checkbox to the left of each capsule to unsync or sync that capsule, respectively.
  • Click "⨉" to remove the capsule from your workspace. (This will not delete the capsule on disk.)
  • Click the folder icon to open an existing capsule and add it to your workspace.
  • Click the plus icon to create a new capsule.

Errors & Warnings (Cmd+2 / Ctrl+2): Show problems Bixby Studio has found in the currently open capsules, listed by file. Open any file listed here in the editor by clicking on it to reveal a list of errors and warnings within that file. Click on a line number to be taken directly to that line in the file.

Simulator (Cmd+7 / Ctrl+7): Open the Device Simulator in a separate window.

Submissions (Cmd+8 / Ctrl+8): Show the status of your submissions to the Bixby Developer Center.

  • Click on any of the submissions to see information about that submission and view logs. Submission information opens as a new tab in the editor (area 3).
  • Use the search field to search through your submission history. You can search for text in both titles and descriptions.
  • Create new submissions with the Create New Submission button, which will also open a new tab in the editor.

Developer Center: Open the Bixby Developer Center in your browser.

Settings: display the settings for Bixby Studio as a whole. These open as a new tab in the editor.

Sidebar

The sidebar's view changes depending on which application tab is open:

  • In the Files view, the sidebar shows the open capsules and their resources.
  • In the Errors & Warnings view, the sidebar shows only resources that have associated errors and warnings, such as syntax errors or deprecated keys.
  • In the Submissions view, the sidebar shows a history of your capsule submissions to the Bixby Developer Center.

In any view, you can click on an element (a file or a submission) to open it as a tab in the editor.

Editor

The editor allows you to create and edit your capsule's resources. When source code is open, as in the screen shot above, the editor behaves like other code editors you might have used. Bixby Studio provides syntax highlighting for Bixby Language and JavaScript, along with automatic indenting and other helpful editing features. Bixby Studio will also show you errors and warnings in your code in real time.

The editor can have more than one file open at a time. Similar to web browsers, multiple files open in tabs along the top of the window showing the filename (or other informational view, such as training or a submission). The top right corner of the editor displays the number of open tabs; you can click in that corner to get a dropdown list of all open tabs. This lets you easily navigate between tabs even when there are more open than can fit along the top of the editor window.

Training for your capsule also opens as a tab in the editor.

If Bixby Studio is in the Submissions View, clicking on a submission opens an information screen in the editor describing the currently-selected submission. On this screen, you can view logs from the submission process by clicking the "Out" log files in the Reports column. This view is not editable.

Status Bar

The bottom of the window displays the status of your Bixby Studio's connection to the server and how recently your local capsules have been compiled.

Editing

In addition to Bixby's own language and markup, Bixby Studio has features for JavaScript. These include syntax highlighting, smart indenting, autocompletion, and realtime code error-checking. The editor also has some customization settings, including dark and light themes.

Keyboard Shortcuts

Nearly all tasks in Bixby Studio can be accomplished through keyboard shortcuts rather than using the mouse and menus. Bixby Studio generally follows standard platform conventions for keyboard navigation, selection, and clipboard (cut/copy/paste).

For a full list of Bixby Studio keyboard shortcuts, refer to the cheatsheets.

In addition to menus, you can use the Command Palette to find and execute commands, including commands that do not have shortcuts assigned to them. Bring up the command palette with Shift+Ctrl+P or Shift+Cmd+P. You can search for commands in the palette using fuzzy rather than exact matching: commands will be searched for as you type, and "Check for updates..." could be matched with "check", "upd", or "cfu".

Creating Files

You can create new files within a capsule by clicking Add to Workspace and Create File or by using the New File... command in the File menu. The Create New File dialog box lets you specify the kind of file you're creating, its location, and for certain kinds of files, provides starter templates to make file creation easier.

Bixby Developer Studio window

Use the File Type dropdown to specify the kind of file you're creating. Bixby Studio will fill in the "Name" field with the suggested directory to use within your capsule. Different dropdowns become available depending on the file type you select; for instance, if you select "Training," you can select the device and language, and Bixby Studio will set the filename correctly based on your selections.

For certain kinds of files, such as models, you can select a template (such as Action, Structure, or a primitive Concept type). When you select a template, Bixby Studio will create the file with appropriate starter content. For instance, if you select a file type of Model, a template of Action, and change the filename to CreateWidget.model.bxb, you'll get the following template:

action (CreateWidget) {
description (__DESCRIPTION__)
collect {
input (__INPUT_NAME__) {
type (__INPUT_TYPE__)
min (Optional) max (One)
}
}
output (__OUTPUT__)
}

Opening and Saving Files

You can open files by clicking them in the file view or by opening them by name. Use Ctrl+P or Cmd+P to find any file in the currently-opened capsule with fuzzy matching.

To save the current file, use Ctrl+S or Cmd+S; to save all modified files, use Ctrl+Alt+S or Cmd+Option+S. (You can also use the corresponding commands in the File menu.) Bixby Developer Studio can be set to automatically save as you work, compiling modified files in your capsule in the background; for this feature, select Enable Autosave in the editor's settings.

When you quit Bixby Studio, it saves its current state. When you restart, it will open the same capsules and editor tabs.

Settings

Clicking the Settings icon at the bottom of the application tab bar (or using the menu command or keyboard shortcut) will open Bixby Studio's settings in a new tab in the editor. This lets you configure the following options:

  • Server: Unless instructed otherwise, leave this set to https://bixbydevelopers.com.
  • General
    • Enable Preview Tab: control click behavior in the file list. If Preview Tabs are enabled, single-clicking a file previews it in a new tab and double-clicking it opens it for editing; if they are disabled, single-clicking a file opens it for editing.
    • Enable Autosave: if selected, the editor will automatically save changes in files in the background.
  • Editor
    • Theme: Allows you to switch between dark and light editor themes.
    • Font: Lets you choose the font for code editing. You can use Bixby Developer Studio's built-in default, your system's default, or specify a custom font.

Testing

In addition to editing, Bixby Studio has tools designed to help you test your capsule. Read about them in their own sections: