Module Utility CLI Quick Start

The Alexa Connect Kit (ACK) Module Utility is a tool for you to manage your ACK module. You can use this tool to perform common tasks either from the command line, or in scripts when you develop and manufacture a product built with ACK. For details, see the Module Utility CLI Reference.

Common tasks that you perform with the Module Utility include:

  • Generate barcodes for customer product registration.
  • Update the module's firmware over the wire.
  • Provision the module as a specific product, such as a smart light.

Prerequisites

  • A Development Kit for ACK, or a printed circuit board assembly (PCBA) with an integrated ACK module and a debug port.
  • A micro-USB to USB-B or USC-C cable.

Step 1: Get the software

  1. Download the Module Utility from the Resources page of the ACK developer console.

  2. You need Java SE 8 or later to use the ACK Module Utility CLI. For installation instructions, see Java SE Downloads.

    To check what version of the Java SE that you have installed, open a terminal window or command prompt and run:

    java -version

    If Java SE is installed, you see output similar to the following.

    java version "1.8.0_221"
    Java(TM) SE Runtime Environment (build 1.8.0_221-b11)
    Java HotSpot(TM) 64-Bit Server VM (build 25.221-b11, mixed mode)
    

    If you see a message with a version lower than 1.8.0, or an error message, Then either Java is not in your PATH, or you to need to download and install Java SE on your computer. If you have already downloaded and installed Java SE, you might need to set or change your PATH system variable.

Step 2: Connect the debug port to your computer

Connect your ACK hardware debug port to your computer. If you are using a Development Kit, see connect the development board to your computer.

Step 3: Use the Module Utility CLI

The Module Utility CLI is a Java-based executable JAR file. You run the CLI from a terminal application on your computer. When you use the CLI, start each command with java -jar <path_to_ackmoduleutility.jar>. For example, to check the version of the ACK Module Utility, open a terminal window, and run the version command. Enter the following code into the terminal:

$ java -jar <path>/ackmoduleutility.jar version

Output similar to the following appears:

Version: 4.0.2.0