Skip to content
This is the development version of the documentation. It may change before the next release. See 0.9.x for the latest release.

Console

autd3-console is a GUI tool that gathers firmware flashing, the simulator, TwinCAT setup, and appliance operation in one place.

It is distributed via GitHub Releases (console-v*). Open console-v0.9.0 and run the install command shown there.

The installer puts the executables in ~/.autd3/bin (%USERPROFILE%\.autd3\bin on Windows) and adds that directory to PATH. Reopen the shell (the terminal on Windows) for the PATH change to take effect.

If you do not use the installer, download the archive from the same release (console-<target>.tar.xz / .zip), extract it, and run autd3-console.

The macOS binaries are not signed or notarized with an Apple Developer ID, so Gatekeeper blocks them with “cannot be opened because the developer cannot be verified”. Remove the quarantine attribute after installing to run it:

xattr -d com.apple.quarantine ~/.autd3/bin/autd3-console

If you are running an extracted archive, apply it to the extracted directory instead:

xattr -dr com.apple.quarantine <extracted directory>

The same archive carries the commands you can run directly without the GUI.

Command Purpose
autd3-console The GUI itself
autd3-appliance Discovering and operating the appliance
autd3-firmware-writer Flashing the firmware (JTAG)
autd3-rs-firmware-ota Updating the firmware (EtherCAT)
autd3-rs-simulator The simulator

The Windows build additionally carries twincat-cli, used for TwinCAT setup.

Tabs are shown along the top once it starts.

Tab Contents
Simulator Launching the simulator
Appliance Discovering the appliance, showing its status, opening and closing the bus
TwinCAT TwinCAT setup (shown on Windows only)
Firmware Updating the firmware (JTAG / EtherCAT)

It checks for a newer release at startup. If it was installed with the installer it can update itself; if you are running an extracted archive it opens the Releases page instead.