Moku API

# Downloading bitstreams

Bitstreams contain the instrument logic and are released with each MokuOS update. To download the bitstreams using Moku CLI, download the mokucli installer from our Utilities (opens new window) page, install Moku CLI, then run the command mokucli instrument download <MokuOS_version>.

$ mokucli instrument download 4.0.1
ℹ Resolved Version 4.0.1 to instruments build 18260
  Downloading 362 bitstream(s) matching 'all'... ━━━━━━━━━━━━━━━━━ 100% 0:00:00
✓ Downloaded 362/362 bitstream(s)
1
2
3
4

For further documentation, see the mokucli docs

# Advanced

# Custom data location

To manually download and provide bitstreams to Python and MATLAB clients, you can set the MOKU_DATA_PATH environment variable.

Determine the directory path where you have downloaded the bitstreams. Once you have the directory path, you can use it for both Python and MATLAB clients in the following ways:

For Python:

  • Simply provide the directory path as is to the Python client.

    • For Linux/macOS:
    export MOKU_DATA_PATH=/path/to/bitstreams/directory
    1
    • For Windows (Command Prompt):
    set MOKU_DATA_PATH=C:\path\to\bitstreams\directory
    1
    • For Windows (PowerShell):
    $env:MOKU_DATA_PATH = "C:\path\to\bitstreams\directory"
    1

For MATLAB:

  • Locate the downloaded tar ball file on your system.

  • Extract the contents of the tar ball to a directory of your choice.

  • Note down the path of the extracted directory. The extracted directory will have a similar structure to /path/to/extracted/bitstreams/mokudata-<fw_version>

    • In MATLAB Command Window:
    setenv('MOKU_DATA_PATH', '/path/to/extracted/bitstreams/mokudata-<fw_version>')
    1

# Legacy options

Legacy: For versions before MokuOS 4.0.1

These are legacy options, they will not work for newer versions of MokuOS

To download the bitstreams using the Python client, simply run the command moku download --fw_ver=<fw_version>. In MATLAB, you can use the function moku_download(<fw_version>) to achieve the same.

If you need to manually download the bitstreams or utilize the REST interface directly, follow the steps below:

  • Enter the firmware version in the provided field.
  • Click the "Download Bitstreams" button to initiate the download.

Once the file is downloaded, you can extract its contents by unzipping the tarball. Inside the extracted files, you will find directories containing the bitstreams for different hardware platforms.

← Overview →