Moku offers APIs for Python, MATLAB, and LabVIEW for seamless automation and integration into your workflow. Starting with MokuOS 4.0, the use of APIs requires the command line utility, mokucli.

What is mokucli?

Mokucli allows users to access and manage Moku hardware through their command terminal. Functionalities include bitstream downloads, device discovery, data streaming, among others. More information on how to use mokucli can be found on this documentation page. 

With the release of MokuOS 4.0, mokucli is required for API integration. 

How do I setup mokucli?

Mokucli can be downloaded from the download links at the bottom of the Utilities page. 

Once downloaded, follow the instructions for installation:

NOTE: If needed, type mokucli --help to list possible functionalities, check the mokucli version, among other tools.

Getting the APIs up and running:

Please make sure the API server is installed after you've updated to MokuOS 4.0. You can check this by right clicking on your Moku device in the app and hovering over “Device Info”. The “API server” should show a version number, as shown in the image below. If it says it is not installed, please follow the instructions in this knowledge base article to install the API server before proceeding to the next step.

Run the following command in your terminal: mokucli instrument download 4.0.1 to download the instrument bitstreams. Replace 4.0.1 with the current most up-to-date firmware release.

If you have not yet used APIs prior to updating to 4.0, please follow the instructions in this Getting Started Guide on how to get the APIs installed. 

Below are the steps to update the APIs with MokuOS 4.0 and above, after mokucli has been installed:

Python:

1. Open your command terminal and update the Python client package by running: pip install --upgrade moku

MATLAB:

1. Open MATLAB after the new mokucli has installed.
2. Go to the “Home” tab and select “Add-ons” to open the sub-menu. Click “Manage Add-Ons”.
3. Look for the moku-MATLAB add-on listed with an available update. NOTE: If you do not see an update option, you likely need to restart MATLAB and try again.
4. Click “Update” and restart MATLAB. The API will be ready for use.

LabVIEW:

1. After installing mokucli and downloading the instrument bitstreams, download the LabVIEW driver from the Liquid Instruments website.
2. Open the file moku_labview_driver.vip with the VI Package Manager (VIPM) and install it. Installation typically takes about one minute. (VIPM is a tool for managing LabVIEW add-ons. The VIPM Desktop App can be downloaded here.)

3. Once installed, the Liquid Instruments Moku package will appear under the Installed list in VIPM.

4. The Moku VI examples can be found at: C:\Program Files (x86)\National Instruments\LabVIEW 2016\examples\Liquid Instruments\Liquid Instruments Moku. The exact path may vary depending on your LabVIEW version and installation directory. Alternatively, the example files can be accessed through the NI Example Finder.
5. More information about getting started with LabVIEW is available on the Liquid Instruments website.

Note: LabVIEW driver version 4.0.1.3 does not currently support Moku:Delta.