You can use APIs for commanding, controlling, and monitoring Moku devices. This guide will walk you through the installation and configuration process of Python APIs using Anaconda on both Windows and Mac operating systems.

→ For Windows system

Downloading Moku CLI and setting environment variables

Moku CLI (mokucli) is a command line utility to quickly access various features of the Moku hardware. It is also used internally by various client driver packages for multiple functions such as decoding data streams.

1.  The latest Moku CLI packages are available to download from Utilities. The installation wizard will configure everything needed to launch the CLI.
2.  Then we will need to manually set MOKU_CLI_PATH environment variable to the absolute path of mokucli. 

• On the Windows taskbar, right-click the Windows icon and select System.
• In the Settings window, under Related links, click Advanced system settings.
• On the Advanced tab, click Environment Variables.

• For System variables, click New to create a new environment variable for MOKU_CLI_PATH.

• Find the Moku CLI path by clicking Browse File…, and the Variable name is set as MOKU_CLI_PATH.

• After creating the Moku CLI environment variable, click OK to have the change take effect. Now you will see Moku CLI is in the list of System variables.

Installing Anaconda, Moku library, and Moku data files

1.  Download Anaconda and follow the installation setup instructions.

2.  When the installation is complete, open Anaconda Navigator (version 2.5.1 in this demo) and launch CMD.exe Prompt.

3.  At the command prompt, install the moku library using pip. A successful installation will be indicated as shown in the screenshot.

4.  At the command prompt, issue the download command. This step downloads Moku data files for all instruments, and it is only required to be run whenever you install or upgrade the Moku library.

5.  From the command line, execute moku list command. This step automatically displays all Moku devices on your network, and it also helps identify Moku's IP addresses. For more detail and other options, see Finding your IP Address.

Running your first program

To validate the successful installation of Moku package, we now run a Python example of Moku Oscilloscope.

1.  From the Anaconda Navigator, launch Spyder.

2.  Paste the example Python code for Moku Oscilloscope into the workspace. Don't forget to modify the IP address to the specific ones of your devices, and change the value of force_connect to True. Then click “Run file” highlighted in red in the screenshot to execute the code. 

3.  Check the Console window for the Python script output.

Explore additional Python examples available here. 

→ For Mac OS

Downloading Moku CLI

Moku CLI (mokucli) is a command line utility to quickly access various features of the Moku hardware. It is also used internally by various client driver packages for multiple functions such as decoding data streams. The latest Moku CLI packages are available to download from Utilities. The installation wizard will configure everything needed to launch the CLI.

Installing Anaconda, Moku library, and Moku data files

1.  Download Anaconda installer compatible with your Mac processor (Intel or M1/M2/M3). Then launch the installer and follow the setup instructions. Under Installation Type, select “Install for me only”. Wait until the installation is complete.

2.  Quit and re-open Mac Terminal , install the moku library using pip. A successful installation will be indicated as shown in the screenshot.

3.  In Terminal window, issue the download command. This step downloads Moku data files for all instruments, and it is only required to be run whenever you install or upgrade the Moku library.

Note: The specified firmware version "587" is the latest as of the creation of this article (Dec 12th, 2023). Please replace this version number with any newer releases if available at the time of your installation.

4.  From the command line, execute moku list command. This step automatically displays all Moku devices on your network, and it also helps identify Moku's IP addresses. For more detail and other options, see Finding your IP Address.

Running your first program

To validate the successful installation of Moku package, we now run a Python example of Moku Oscilloscope.

1.  From the Anaconda Navigator, launch Spyder.

2.  Paste the example Python code for Moku Oscilloscope into the workspace. Don't forget to modify the IP address to the specific ones of your devices, and change the value of force_connect to True. Then click “Run file” highlighted in red in the screenshot to execute the code. 

3.  Check the Console window for the Python script output.

Explore additional Python examples available here.