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.
Common tasks that you perform with the Module Utility include:
- Generate the barcodes used to for customer product registration.
- Update the module's firmware over the wire.
- Provision the module as a specific product, such as a smart light. For information about provisioning, see the Module Life Cycle Overview.
For more information on the Module Utility, see the Module Utility CLI Reference.
Step 1: Prerequisites
Download the Module Utility from the ACK console Resources tab.
You need Java SE 8 or later to use the ACK Module Utility CLI. For installation instructions, see Java SE Downloads.
To check if Java SE is installed
To check what version of the Java SE that you have installed, open a terminal window or command prompt and run:
If Java SE is installed, the output should be something like this:
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 receive a message with a version lower than 1.8.0, any type of error message, or a message similar to:
Java command not found
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 may need to set or change your PATH system variable.
- 1x USI Development Kit, or a development board with an integrated ACK module and a debug port.
- 1x Micro USB to USB-B or USC-C cable.
Step 2: Connect the debug port to your computer
Connect your ACK hardware debug port to your computer. If you are using a USI Development Kit, see connect the development board to your computer for detailed instructions.
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>.
<path_to_ackmoduleutility_version.x.x.x.jar>and any other paths in your commands with the relative path to those files on your computer. For example, when you use the version command, include the actual file path to the ackmoduleutility.jar file on your computer, such as Users/username/downloads/ackmoduleutility_220.127.116.11/ackmoduleutility.jar
For example, to check the version of the ACK Module Utility, open a terminal window, and run the
java -jar <path_to_ackmoduleutility.jar> version
This command will return something like:
- Review the Module Utility CLI reference.