Installing the Blackfynn toolbox

The MATLAB toolbox for Blackfynn allows users to programmatically interact with the Blackfynn platform from MATLAB. This page describes how to install the toolbox from a precompiled toolbox, or using the source-code that is available on Github.

Installing the MATLAB Client

There are two ways to install the MATLAB toolbox. The preferred method is to download the precompiled toolbox and use the installer to make the toolbox available in MATLAB. Alternatively, you can install directly from the sourcecode of the toolbox after downloading or cloning the MATLAB toolbox repository. Use this if you plan to develop new features for the toolbox.

A. Installing precompiled toolbox (preferred)

The preferred method of installing the MATLAB toolbox is by downloading the latest precompiled version of the client. In order to install the client, please follow these simple steps.

1. Install the Blackfynn Agent

  • The Blackfynn MATLAB Toolbox is dependent on the Blackfynn Agent which is installed separately. The Agent provides the functionality to upload data and facilitates performent streaming of data from the the Blackfynn servers to local clients. Please follow the instructions to install the Blackfynn Agent.

2. Install the MATLAB Toolbox

InstallScreen
Screenshot of toolbox installation screen

B. Installing from source code

a. Compile MATLAB Toolbox locally

  • Download, or checkout the source code from the source code repository MATLAB client repository
  • (Only for download) Extract contents of the downloaded file into a folder
  • Modify the [MATLAB_LOC] variable in the setup.sh script to point to your local MATLAB executable.
  • Run the setup script:
>> cd setup
>> ./setup.sh
  • Open the resulting toolbox installer to install the local toolbox.

b. Adding sourcecode location to the MATLAB path

  • Download, or checkout the source code from the source code repository MATLAB client repository
  • (Only for download) Extract contents of the downloaded file into a folder
  • Modify the [MATLAB_LOC] variable in the setup.sh script to point to your local MATLAB executable.
  • Add the compiled JAVA libraries to your MATLAB static Java classpath:
>> cd(prefdir)
>> edit javaclasspath.txt

then add this lines (update path) and restart MATLAB:

/.../blackfynn-matlab/java/blackfynio.jar
/.../blackfynn-matlab/java/matlab-websocket-1.4.jar
/.../blackfynn-matlab/java/protobuf-java-3.5.1.jar
  1. Add the path of the Blackfynn client folder to the MATLAB path or work from the toolbox folder. This can be done in MATLAB as follows:
>> addpath('/.../blackfynn-matlab');