Module Utility CLI
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 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.
Module Utility CLI Quick Start
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.
- Java SE 8 or later. For Java installation instructions, see Java SE Downloads
Step 1: Download the ACK Module Utility
Download the ACK Module Utility from the Resources page of the ACK developer console and unzip it to a convenient location.
Step 2: Connect the debug port to your computer
Connect your ACK hardware debug port to your computer. If you're using an ACK development kit, see connect the development board to your computer for more details about how to set up your kit.
Step 3: Use the Module Utility CLI
The ACK Module Utility CLI is a Java-based executable JAR file. You run the CLI from a terminal window 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 your ACK Module Utility
Open a terminal window, and run the version
command.
$ java -jar <path>/ackmoduleutility.jar version
When you run this command, an output similar to the following appears:
Version: 4.0.2.0
<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 path to the ackmoduleutility.jar
file on your computer, such as Users/username/downloads/ackmoduleutility_4.0.20.0/ackmoduleutility.jar