Moku API

# Downloading bitstreams

Bitstreams contain the instrument logic and are released with each MokuOS update. To download the bitstreams using MokuCLI, download the MokuCLI installer from our Utilities (opens new window) page, install MokuCLI, then run mokucli instrument download with your Moku's IP address. This downloads the files that match your Moku's hardware and MokuOS version.

$ mokucli instrument download --ip 192.168.###.###
ℹ Using device release version: 4.4.0
ℹ Resolved Version 4.4.0 to instruments build 21738
  Downloading 92 bitstream(s) matching 'all'... ━━━━━━━━━━━━━━━━━━ 100% 0:00:00
✓ Downloaded 92/92 bitstream(s)
1
2
3
4
5

To download the files without connecting to a Moku, give the MokuOS version instead, e.g. mokucli instrument download 4.4.0. This downloads the files for all Moku hardware, about 2 GB.

For further documentation, see the MokuCLI docs

# Advanced

# Custom data location

To keep the instrument files somewhere other than the default location, download them to a directory of your choice with --target, then set the MOKU_DATA_PATH environment variable to that directory. The Python and MATLAB clients then load the instrument files from there.

$ mokucli instrument download --ip 192.168.###.### --target /path/to/moku/data
1

For Python:

  • For Linux/macOS:

    export MOKU_DATA_PATH=/path/to/moku/data
    1

  • For Windows (Command Prompt):

    set MOKU_DATA_PATH=C:\path\to\moku\data
    1

  • For Windows (PowerShell):

    $env:MOKU_DATA_PATH = "C:\path\to\moku\data"
    1

For MATLAB, in the Command Window:

setenv('MOKU_DATA_PATH', '/path/to/moku/data')
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 →