Skip to content

Installation

Prerequisites

Before installing, make sure you have:

  1. Docker installed and running
  2. Python 3.8+ installed
  3. Administrator/sudo access (for USB permissions)

Installing Docker

  1. Download Docker Desktop for Windows
  2. Run the installer
  3. Enable WSL2 when prompted
  4. Restart your computer

Windows Home Users

Make sure you have Windows 10 version 2004 or higher

  1. Download Docker Desktop for Mac
  2. Open the .dmg file and drag Docker to Applications
  3. Start Docker from Applications

Apple Silicon (M1/M2)

Docker Desktop supports ARM natively - no special setup needed

# Ubuntu/Debian
curl -fsSL https://get.docker.com | sudo sh
sudo usermod -aG docker $USER

# Log out and back in for group changes

Installing embsec/dev

Run this single command:

curl -sSL https://embsec.gitlab.io/dev/install | bash

The installer will: - ✓ Check your system requirements - ✓ Download the embsec CLI tool - ✓ Set up your shell environment - ✓ Run initial configuration

First-Time Setup

After installation, initialize the environment:

embsec init

This downloads the Docker container (~850MB) with all the development tools.

USB Setup for TM4C123G

Add yourself to the dialout group: 

sudo usermod -aG dialout $USER
# Log out and back in

USB works automatically through Docker Desktop.

Install usbipd to share USB devices with WSL:

  1. In PowerShell as Administrator: 

    winget install dorssel.usbipd-win

  2. Share the TM4C123G when connected: 

    # List devices
usbipd wsl list

# Attach TM4C123G (replace 1-1 with your bus ID)
usbipd wsl attach --busid 1-1

Verify Installation

Check that everything is working:

# Check installation
embsec --version

# Run system diagnostics
embsec doctor

# Start the environment
embsec up

You should see VS Code open in your browser at http://localhost:8443

Troubleshooting

Docker not running? - Windows/Mac: Start Docker Desktop from your applications - Linux: sudo systemctl start docker

Permission denied? - Make sure you're in the docker group: groups - Log out and back in after adding groups

Can't access USB? - Run embsec doctor --usb-only for USB diagnostics - Make sure the TM4C123G is connected before running embsec up

Next Steps

Continue to First Use to create your first project!