⚠️ Active Development Notice This project is under active development. APIs and internal structures may evolve as we continuous align cross-team requirements.

Sapas /sa'paʃ/ — Inspired by the phrase for "Bravo! Well done!" Our goal is simple: automate your hardware tests seamlessly from early-stage bring-up to high-throughput production.

A unified hardware test automation platform for the entire product lifecycle — bridging the gap between RD verification, CI/CD Hardware-in-the-Loop (HIL) testing, factory production, and RMA diagnostics.

sapas is completely free and open-source under the MIT license! You can freely clone it, modify it, and use it in your personal projects or commercial factory production lines without any cost.

In the lifecycle of hardware product development, testing is often fragmented across different teams and phases:

1. RD (Research & Development) writes custom validation scripts in the lab to bring up the hardware and run sweeps.
2. QA/TE (Quality Assurance & Test Engineering) re-writes validation test benches for regression and reliability testing.
3. PE (Production/Manufacturing) struggles to deploy a frankenstein framework on the shop floor, leading to untraceable bugs and heavy maintenance.
4. RMA (Return Merchandise Authorization) uses different ad-hoc tools to diagnose returned devices.

Sapas is built to break these silos. It is NOT just another "high-performance" runner; it is a unified hardware testing platform designed to be the single source of truth from early engineering labs to continuous assembly lines and service centers.

Sapas's decoupled architecture makes it versatile across multiple stages of hardware development:

• 🔬 RD Lab & Characterization: Sweep testing, calibration, and characterization (e.g., PVT testing) without writing boilerplate logging or reporting logic.
• 🤖 CI/CD & HIL (Hardware-in-the-Loop): Run daily smoke tests or firmware regression validation on physical test benches automatically on every code commit.
• 🏭 Factory Production Lines: Station looping, operator-friendly TUI, barcode serial number bindings, and secure data convergence for shopfloor databases.
• 🔧 RMA & Field Service Diagnostics: A lightweight, terminal-based TUI tool for repair centers to run step-by-step guided hardware diagnostics on technicians' laptops.

Sapas provides a clean abstraction layer that allows RD, TE, and Factory operators to speak the exact same language:

• For RD (Lab Verification): It acts as a structured environment to write modular TestItem blocks using standard protocols (SSH, ADB, UART) without worrying about factory databases or UI rendering.
• For TE (Deployment & Criteria): It separates test logic from standard criteria. TE can shift test limits or sequencing via dynamic configuration files (YAML/CSV) without touching the core code written by RD.
• For Factory Control & Automation: It wraps everything into a robust, operator-friendly CLI/TUI environment. It handles continuous looping, serial number inputs, and data hygiene automatically.

• Bridge the Gap: Stop re-writing scripts. The exact same Python code written during early validation can be directly deployed onto the production line or used in automated regression testing.
• Separation of Concerns:
  • RD controls the Logic (How to interact with the device).
  • TE controls the Criteria & Sequence (What defines a PASS/FAIL and in what order).
  • Sapas Engine controls the Infrastructure (Logs, UI, data convergence, and hardware connection pools).
• Defensive by Design: Implements strict data normalization (e.g., rigid boolean convergence) and contract checking (opas.var.require) to prevent laboratory scripts from breaking under harsh factory environments.
• Aesthetic & Noise-Free CLI: A unified terminal output powered by rich, using balanced visual markers (✓ / ❌) ensuring that field technicians or developers can instantly read station health without parsing through raw text noise.

Explore the full guides in your preferred language:

• 🇺🇸 English Documentation
  • Quick Start | Architecture | Station Loop Mode
• 🇹🇼 繁體中文說明文件
  • 快速開始 | 架構設計 | 生產線站點部署

• Sequence-Driven Framework: Test paths are decoupled from implementation. Sequences are orchestrated via configuration files, allowing rapid updates on the shop floor.
• Unified Result Manager: Eliminates fragmentation in telemetry. Every single test module feeds into a standardized data model, ensuring tracking stability across all shifts.
• Multi-Protocol Link Layer: Built-in support for standard engineering interfaces (ADB, UART, and SSH) so teams don't reinvent connection wrappers.

To install or update Sapas in editable mode for cross-team development (this automatically updates dependencies such as `textual`):To install Sapas in editable mode for cross-team development:

# 1. Clone the repository and install Sapas
git clone [https://github.com/kumamodo/sapas.git](https://github.com/kumamodo/sapas.git)
cd sapas
pip install -e .

# 2. Go to the example project folder (CRITICAL!)
cd example/

# 3. Run the automation platform (Choose one mode below)
# Mode A: Standard CLI Mode
sapas --project Alishan --station Function

# Mode B: Interactive TUI Dashboard (Recommended for Stations)
sapas --project Alishan --station Function --tui

Alternatively, to avoid typing long arguments, you can pre-define your target environment inside site_infra.yaml:

# site_infra.yaml (Example for Alishan)
PROJECT_NAME: Alishan
STATION_NAME: Function

Once this file is set up, simply navigate to that project directory (example/) and execute the bare command:Execute sapas in your project root. See the Alishan example for a complete demonstration.

sapas
# or for TUI dashboard
sapas --tui

Single-Step Script Execution (Isolated Testing)

During development or factory-line debugging, you do not need to run the entire station testing loop just to verify a single modification. **Sapas** allows you to execute any individual `TestItem` or `ActionItem` script independently right from your project root directory. Simply open your terminal at the project root and pass the filename directly to the `sapas` CLI:

sapas get_os_name.py