Skip to content

PLC Scope Python (TUI)

Python 3.11+ License: MIT Static Analysis: Ruff

A high-performance Terminal User Interface (TUI) application for real-time PLC device monitoring. Designed to provide a GUI-like dashboard experience directly in your terminal across multiple PLC vendors.

Key Features

  • TUI Dashboard: Rich graphical display within the terminal (built with Textual/Rich).
  • Cross-Vendor Support: Unified interface for Mitsubishi (SLMP), JTEKT (Toyopuc), and Keyence (Host Link).
  • Provider Architecture: Logic is cleanly separated from UI, consuming internal sibling libraries.
  • Single-File Distribution: Packaged as a standalone EXE for easy deployment.

Quick Start

Run from Source

python src/main.py

Build Standalone EXE

run_ci.bat

The executable will be generated in the publish/ directory.

Documentation

Follows the workspace-wide hierarchical documentation policy:

  • User Guide: Dashboard controls and connection setup.
  • Screenshots: Visual gallery of the TUI in action.
  • Architecture: Details on the Provider Pattern and internal drivers.
  • QA Reports: Verified performance and stability metrics.

Development & CI

Quality is enforced via run_ci.bat.

Quality Checks

  • Linting & Formatting: Ruff
  • Type Checking: Mypy

Distribution

This project uses PyInstaller to bundle the core application with specific vendor drivers into a single-file executable.

License

Distributed under the MIT License.