User Guide

Comprehensive guides for using adi-labgrid-plugins.

Core

• Using Drivers
  • Overview
  • Driver Lifecycle
  • Network Drivers
  • Power Control Drivers
  • Shell and File Transfer Driver
  • Storage Management Drivers
  • Kuiper Linux Driver
  • Cloudsmith Download Driver
  • FPGA JTAG Driver
  • Software Provisioning Driver
  • See Also
• Configuring Resources
  • Overview
  • Resource Definition Patterns
  • Resource Types and Configuration
  • Configuration Best Practices
  • Testing Configuration
  • Resource Declaration Patterns
  • Common Configuration Issues
  • See Also
• Working with Strategies
  • Overview
  • BootFPGASoC Strategy
  • BootFPGASoCSSH Strategy
  • BootFPGASoCTFTP Strategy
  • BootZynq7000JTAGRecovery Strategy
  • BootNoOSJTAG Strategy
  • BootSelMap Strategy
  • BootRPI Strategy
  • Best Practices
  • Custom Strategy Development
  • BootFabric Strategy
  • SoftwareProvisioningStrategy
  • State Transition Reference
• Command Line Interface
  • Installation
  • Global Options
  • Commands
  • Examples
  • Standalone download tools
• adi-lg-hw-ci — Hardware-CI helper
  • Discovery and matrices
  • Env rendering
  • no-os build and XSA
• Model Context Protocol (MCP) Server
  • Installation
  • Running the Server
  • Client Examples
  • Exposed Tools
  • Resources
  • Logging and Progress

Hardware CI

• Onboarding a Consumer Repo
  • How the flow works
  • Step 1 — choose a mode
  • Step 2 — what you’ll touch
  • uri mode (pytest over libIIO)
  • flash mode (no-os firmware)
  • matlab mode (MATLAB runHWTests)
  • Step 3 — set the three repo variables
  • Step 4 — coordinator + lab prerequisites
  • Step 5 — verify before opening the PR
  • Drop in an AGENTS.md
  • Troubleshooting
• GitHub Actions (Reusable Workflows)
  • Choosing a workflow
  • hw-matrix.yml — manifest-first matrix
  • hw-matrix-v2.yml — discovery-driven matrix
  • hw-request.yml — low-config by-part
  • matlab-hw-request.yml — MATLAB by-part
  • noos-hw-request.yml — no-os firmware flash
  • Composite actions
  • Registering self-hosted runners
  • Runner labels and cross-org scope
• Hardware CI by part (hw-request)
  • How it differs from hw-matrix.yml
  • Calling it
  • What happens
  • Boot verification and failure semantics
  • Reserve mode (consumer-driven boot)
  • Requirements
  • Uploading results to Prism
  • Flash mode (no-os)
• Hardware-CI Runner Setup (no-os flash mode)
  • Runner requirements
  • The manifest
  • The consumer workflow
  • What happens per leg
  • Troubleshooting
  • See also

Coordinator & exporters

• Coordinator Setup
  • Architecture
  • Prerequisites
  • Quick Start
  • Configuration
  • Connecting Exporters
  • Testing Without Hardware
  • API Reference
• Running Coordinator Tests
  • Prerequisites
  • Smoke Tier
  • Hardware Tier: Three Exporter Modes
  • Env YAML vs. Exporter YAML
  • Troubleshooting
• Web Dashboard
  • Dashboard Page
  • Places Page
  • Resources Page
  • Reservations Page
  • Real-Time Updates
  • Color Mode
• Exporter Setup
  • Resource Configuration
  • Using Templates
  • Validating Configurations
  • Running the Exporter
  • Setting Up Places
  • Group Naming Convention
• Exporter Deployment
  • Prerequisites
  • Install ser2net 4.6.1
  • Install adi-labgrid-plugins
  • Run the Exporter
  • Verify Registration
  • Troubleshooting

Legacy / reference (deprecated)

• Hardware CI (v1, manifest-first)
• Hardware CI v2 (discovery-driven)
• Hardware CI for bash / non-Python test drivers (UART + JTAG)

• Common Use Cases
  • Basic Power Control
  • Serial Console Access
  • File Transfer via XMODEM
  • Automated Boot Sequences
  • SD Card Management
  • Kuiper Release Download
  • Testing Pattern with pytest
  • Multi-Device Coordination
  • CyberPower PDU Control
  • See Also