SDM CLI Tool#

Install the SDM Package#

Simplicity Device Manager (SDM) is installed through Silicon Lab Tools (SLT) as the sdm package.

slt install sdm

The package includes the following subpackages:

  • sdm-cli

  • sdm-service

  • sdm-ui

  • sdm-meta

  • sdm-mcp

  • sdm-shrike

  • segger-driver

Set Up the Environment#

Add sdm to your PATH.

Locate the installed sdm package:

slt locate sdm

Find the sdm entry and copy the path to the folder that contains the sdm executable.

Windows#

Add the SDM folder to the user Path environment variable:

  1. Open Edit the system environment variables....

  2. Click Environment Variables.

  3. Select Path.

  4. Click Edit.

  5. Add the SDM executable folder. For example:

    C:\Users\<username>\.silabs\slt\installs\archive\sdm-windows-x64\
  6. Click OK.

  7. Open a new terminal and verify the installation:

    sdm --help

macOS#

Add the following line to your shell profile, replacing the path with the folder returned by slt locate:

export PATH="$HOME/.silabs/slt/installs/archive/sdm-darwin-arm64:$PATH"

Open a new terminal and verify the installation:

sdm --help

Linux#

Add the following command to your shell profile, replacing the path with the folder returned by slt locate:

export PATH="$HOME/.silabs/slt/installs/archive/sdm-linux-x64:$PATH" 

Open a new terminal and verify the installation:

sdm --help

Command Reference#

Run the following command to display information about all available SDM commands:

sdm --help

Run the following command to show all options for a specific command:

sdm <command> --help

Available Commands#

Command

Description

adapter

Adapter management

apack

Manage adapter packs

art

Print SDM art

board

Commands for working with the board database

ci

Commands for capture interfaces

combine-binaries

Combine two binary files into one

commander

Commands related to Simplicity Commander

completion

Generate an autocompletion script for the specified shell

config

Interact with configuration settings

extcap

Entry point for handling the Wireshark extcap interface

file

File-related commands

help

Help about any command

isd

Top-level command for managing ISD files

jlink

J-Link-related commands

kit

Commands for working with the kit database

lock

Commands for managing device and other locks

part

Commands for working with the part database

pcap

Top-level command for all PCAP or PCAPNG file mangling

ping

Send a simple ping to the server

rps

Commands for working with RPS files

selfcheck

Analyze the Simplicity Device Manager installation

server

Various server commands

shrike

Interface for running the Shrike test adapter

tag

Various tag commands

terminal

Opens a terminal session

ui

Interact with the user interface application

wireshark

Commands for working with Wireshark

Example Workflow#

  1. Show available commands:

    sdm --help
  2. Discover connected devices:

    sdm adapter list
  3. Inspect a connected device:

    sdm adapter info --adapter <adapter string>
  4. Flash a binary to a device:

    sdm adapter flash --adapter <adapter string> --file <file path>/<file name>.<file extension>
  5. Open a terminal for serial communication:

    sdm terminal --adapter <adapter string> --connections <connection string>