Skip to content

Command Reference

Espen Hovland edited this page Jun 5, 2026 · 2 revisions

Command Reference

This is the reference for the low-level [[Commander-Class|Commander]] command suites. Each suite is an attribute on a Commander instance (commander.flash, commander.device, …), and each method maps to a Simplicity Commander CLI command. Every method returns the parsed-JSON output as a dict (equivalent to running the CLI with --json).

from pycommander import Commander
commander = Commander(serial_number="440055955", target_device="EFR32MG24")

result = commander.device.info()
if result["success"]:
    print(result["result"]["device_info"])

Conventions used in this reference

  • Connection / device / debug options (serial_number, ip_address, serial_port, target_device, debug_*) can be passed to most methods as **kwargs to override the values set on the Commander. Additional recognized keys: force, devicexml. See Python-API-Overview.
  • Ranges are tuple[int | str, int | str](start, end). Integers are formatted as 8-digit hex (0xXXXXXXXX); strings are passed through, so you can use @region-style or start:+length forms where Commander allows.
  • Patches are tuple[int|str, int|str, int|str|None](address, data[, length]).
  • Tokens are tuple[str, str](TOKEN_NAME, value).
  • A leading --noXxx flag is emitted when a bool parameter that defaults to True is set to False (e.g. reset=False--noreset).

Suites by page

Suite Class Page
adapter AdapterCommand Reference-Adapter-AEM-VCOM
aem AemCommand Reference-Adapter-AEM-VCOM
vcom VcomCommand Reference-Adapter-AEM-VCOM
ctune CtuneCommand Reference-Adapter-AEM-VCOM
device DeviceCommand Reference-Device-Flash-Memory
flash FlashCommand Reference-Device-Flash-Memory
verify VerifyCommand Reference-Device-Flash-Memory
readmem ReadmemCommand Reference-Device-Flash-Memory
extflash ExtflashCommand Reference-Device-Flash-Memory
security SecurityCommand Reference-Security
tokens TokensCommand Reference-Tokens-NVM3-LittleFS
nvm3 Nvm3Command Reference-Tokens-NVM3-LittleFS
littlefs LittlefsCommand Reference-Tokens-NVM3-LittleFS
convert ConvertCommand Reference-Image-Files
ebl EblCommand Reference-Image-Files
gbl3 Gbl3Command Reference-Image-Files
gbl4 Gbl4Command Reference-Image-Files
ota OtaCommand Reference-Image-Files
rps RpsCommand Reference-Image-Files
postbuild PostbuildCommand Reference-Image-Files
util UtilCommand Reference-Utilities
serial SerialCommand Reference-Utilities
mfg917 Mfg917Command Reference-Utilities

Not exposed here

Interactive CLI suites (vuart, rtt, swo, and the interactive vcom/vuart sessions) are intentionally not part of the typed API. Use commander.runCommand(...) to invoke them directly — see Commander-Class.

For higher-level, task-oriented wrappers around many of these commands, prefer Adapter-Class and Target-Class.

Clone this wiki locally