Installation

A note to developers

The currently available SDK is a great place for developers to start to experiment and learn about building skills for Jibo. We are working on the next version of the SDK, which will expand your toolkit and make it even easier to build skills for Jibo.

Skills built with the current version will run in the future SDK environment with modest rework, and we will minimize breaking changes as much as possible. If any should arise, we will document thoroughly.

Have fun! As always, let us know what you build on our developer forum or contact us with any questions.

- Jibo SDK Team

Release Notes

Please see the Jibo SDK Release Notes for new features, breaking changes, and known issues.

System Requirements

Please note that we do not support Linux or virtual machines (VMs) at this time.

OSX

  • OSX 10.9 or later
  • Minimum 8GB RAM (12GB recommended)
  • Node.js v4.5.0 (comes with npm 2.15.9)
  • Xcode command line tools (to run native code):
    • Run: xcode-select --install
    • Click Install at the first prompt.
    • Click Agree at the second prompt.
  • Atom v1.11.1
    • Note: the current SDK requires the v1.11.1 version of Atom.
    • Open Atom, then click Atom > Install Shell Commands.
    • To keep Atom from auto updating: Go to Atom > preferences > core in Atom and unchecking the Automatically Update box on that page

atom_core_settings.png

Windows

Please note that several programs are needed in order to successfully install the Jibo SDK on Windows. Please make sure to install all the programs listed below, including Visual Studio Community 2015!
  • Windows 8 or later
  • Minimum 8GB RAM (12GB recommended)
  • One of the following command line interfaces:
  • Node.js v4.5.0 (comes with npm 2.15.9)
  • iTunes or Bonjour (to install mDNSResponder.exe to communicate with the robot)
  • Atom v1.11.1
    • Note: the current SDK requires the v1.11.1 version of Atom
    • Open Atom, then click Atom > Install Shell Commands.
    • To keep Atom from auto updating: Go to Atom > preferences > core in Atom and unchecking the Automatically Update box on that page

atom_core_settings.png

  • If you have issues installing Atom, see the Atom forums.
    • Visual Studio Community 2015
      • Tip: We recommend installing Visual Studio after installing Atom to avoid potential package conflicts.
      • If you are installing Visual Studio for the first time, you will have to open Visual Studio and agree to the End User License Agreement before you can use the Jibo SDK.

Installation

Install the Jibo Atom package

The Jibo Atom package (jibo-sdk) includes the Animation Editor and the Behavior Editor and leverages the Simulator.

  1. Open Atom.
  2. Click Atom > Preferences (Mac) or File > Settings (PC) on the menu bar.
  3. Click Install in the left panel.
  4. Type jibo-sdk in the Search packages box, then press enter.
  5. Navigate to the jibo-sdk package from jiborobot in the search results list.
  6. Click the Install button.
    JiboSDKInstall
  7. Run the following commands in Terminal:
    • cd $h; npm install pixi.js@4.0.3
    • cd $h/.atom/packages/jibo-sdk; npm install husl@6.0.1

Log in

  1. Once the jibo-sdk package is installed, you will be presented with a Login window.
    • If the Login window does not open (or if you accidentally close it), click Jibo > Login on the menu bar.
  2. If you are new to the Jibo SDK, click New User? to sign up. It is free to sign up to use the Jibo SDK.
  3. Once your account has been created, follow the on-screen prompts to fill out the Log In form.
  4. Click Log In.

When you see the Jibo toolbar, the jibo-sdk package is installed on your machine! Please complete the Hello World Tutorial to confirm that the SDK has been successfully installed.

Please read the Jibo Atom Package documentation to get started using the Jibo SDK.

Note: If you don't see the Jibo toolbar:

  1. Click View > Developer > Reload Window on the menu bar.
  2. Click the red bug icon (RedBugIcon.png) in the lower-right corner of your Atom window.
  3. Click Rebuild Package.
  4. When you see Rebuild Successful, click the Reload Atom button or click View > Developer > Reload Window on the menu bar.
  5. Note that you may need to click Jibo > Login to log in again.

Install the Jibo CLI

The Jibo Command Line Interface (CLI) allows you to sync skills to your robot.

Note: You only need to complete this section if you have a robot.

  1. Run the following command in Terminal:
    • npm install -g jibo-cli
    • If you receive a permissions issue error when running this command, please make sure you are the root user/administrator of your computer. See the npm documentation for more information on fixing permissions issues.
  2. To verify that the CLI installed correctly, run the following to print a list of reference commands.
    • jibo

Please read the Jibo CLI documentation to get started using the Jibo CLI.

Optional: Install the audio plug-in

This optional plug-in allows you to preview audio files in Atom.

  1. Open Atom.
  2. Click Atom > Preferences (Mac) or File > Settings (PC) on the menu bar.
  3. Click Install in the left panel.
  4. Type jibo audio in the Search packages box, then press enter.
  5. Navigate to the audio package from jiborobot in the search results list.
  6. Click the Install button.

SDK Management

Update the Jibo Atom package

When updates are available for Atom packages (including jibo-sdk), a blue icon (Blue Update Icon) appears in the lower-right corner of your screen.

The Jibo SDK documentation always refers to the most recent version of the jibo-sdk package, so we recommend updating whenever available.

  1. Click Settings on the Jibo toolbar.
  2. Click Updates in the left panel.
  3. If an update is available for jibo-sdk, it will appear in the update list. To refresh the list of available updates, click Check for Updates.
  4. Click Update to... for jibo-sdk.
  5. Click View > Developer > Reload Window on the Atom menu bar.

Jibo SDK Update

Note: If updating stalls, try the following troubleshooting steps:

  1. Click Disable for jibo-sdk.
  2. Click Uninstall for jibo-sdk.
  3. Click View > Developer > Reload Window on the menu bar.
  4. Click Install in the left panel.
  5. Type jibo-sdk in the Search packages box, then press enter.
  6. Navigate to the jibo-sdk package from jiborobot in the search results list.
  7. Click the Install button.

Note: If you don't see the Jibo toolbar:

  1. Click View > Developer > Reload Window on the menu bar.
  2. Click the red bug icon (RedBugIcon.png) in the lower-right corner of your Atom window.
  3. Click Rebuild Package.
  4. When you see Rebuild Successful, click the Reload Atom button or click View > Developer > Reload Window on the menu bar.
  5. Note that you may need to click Jibo > Login to log in again.

Disable the Jibo Atom package

  1. Click Settings on the Jibo toolbar.
  2. Click Packages in the left panel.
  3. Type jibo-sdk in the Filter packages box, then press enter.
  4. Click Disable for jibo-sdk.
  5. Click View > Developer > Reload Window on the Atom menu bar.

Uninstall the Jibo Atom package

  1. Click Settings on the Jibo toolbar.
  2. Click Packages in the left panel.
  3. Type jibo-sdk in the Filter packages box, then press enter.
  4. Click Uninstall for jibo-sdk.
  5. Click View > Developer > Reload Window on the Atom menu bar.

Update a skill to the newest APIs

Please see the API documentation for instructions on updating APIs.