Moku API

# Deploying your design

With your project bitstreams downloaded, the next step is to upload the design on to your Moku device. You can use either the Moku application interface as shown below or with API as shown in examples here.

# Step 1 : Add Moku Compile or Moku Compile+*

Add at least one Moku Compile or Moku Compile+* to your Multi-Instrument Mode configuration:

  1. Click on an empty slot
  2. Select Moku Compile or Moku Compile+
  3. Click on the Apply button

*Available on Moku:Pro and Moku:Delta.

deploy

# Step 2 : Select the instrument file

The Moku Compile instrument requires a customized bitstream (ensure that the MokuOS version and slot number of the bitstreams matches your Moku device configuration).

MokuOS and Slot Mismatch

Trying to deploy Moku Compile bitstream on a Moku with a different MokuOS version or number of slots to what it was built for can cause the Moku to hang, requiring a power cycle.

Open the Moku Compile Browser in the Moku application as shown below:

  1. Click on Select... above the Moku Compile instrument
  2. Click on Select instrument file...

upload-moku-app

The bitstream can either be fetched from the Cloud server or you can manually upload the downloaded bitstream using the following steps.

  1. Click on the Local file... button to access the local file directory
  2. Navigate to the required directory and select the correct bitstreams file
  3. Click on the Open button
  4. Click on the Apply button to deploy the bitstream

upload-bs

# Step 3 : Running the Moku Compile instrument

Utilize the Multi-Instrument Mode configuration screen to connect your design with analog and digital connections, alongside with any additional instruments, as desired. Once the Moku Compile instrument is deployed, you can edit your design's Control registers or view the design's Status registers by clicking on the arrow button at the bottom of the slot, which opens the instrument. For more information, see Control Registers and Status Registers.

With your bitstream now on your Moku device, your custom design can be deployed in whichever slot you put the Moku Compile instrument in Multi-Instrument Mode. The same bitstream does not have to be uploaded again.

deploy-moku-app

# Step 4 : Load a new instrument file

To deploy a different design or an updated build of your design, load the new instrument file into the Moku Compile instrument:

  1. Click on Change... above the Moku Compile instrument
  2. Select the new instrument file from the Moku Compile Browser, either from the Cloud server or with the Local file... button
  3. Click on the Apply button to deploy the new instrument

The new instrument only runs once you click Apply. Uploading the instrument file on its own doesn't change the instrument running on your Moku.

reload-bs-moku-app

← Slot resources and rates →