met_test System Requirements Document

1. Introduction

The met_test project is a next-generation inspection platform inspired by the best aspects of Creaform Metrology Suite and FARO CAM2. It focuses heavily on usability, modern design, and seamless hybrid inspection workflows. This document outlines the system requirements for met_test, ensuring it meets the needs of its users in Portugal and beyond.

2. System Overview

The met_test platform is designed to provide a comprehensive inspection solution with modular capabilities. It supports various inspection modes, including Operator Mode, Engineer Mode, and an optional Expert Mode. The platform emphasizes guided workflows, advanced analysis tools, and flexible configuration options to accommodate different user needs and expertise levels.

3. Functional Requirements

• As an Operator, I should be able to switch between Operator Mode, Engineer Mode, and Expert Mode.
• As an Operator, I should be able to connect and calibrate measurement devices easily.
• As an Operator, I should be able to follow guided inspection sequences with wizard-based workflows.
• As an Operator, I should be able to probe features and collect measurements with large buttons and minimal settings.
• As an Operator, I should be able to perform 3D scans efficiently.
• As an Operator, I should be able to run predefined inspection plans.
• As an Operator, I should be able to review pass/fail results quickly.
• As an Operator, I should be able to generate standard reports.
• As an Engineer, I should be able to create full inspections with advanced GD&T.
• As an Engineer, I should be able to use a feature tree for detailed analysis.
• As an Engineer, I should be able to customize reports.
• As an Expert, I should be able to perform advanced alignments.
• As an Expert, I should be able to use custom scripting for automation.
• As an Expert, I should be able to diagnose devices.
• As a User, I should be able to configure the platform flexibly to suit my workflow needs.

4. User Personas

• Operator: Focuses on guided and task-oriented workflows with minimal settings and a pass/fail focus.
• Engineer: Engages in full inspection creation with advanced analysis tools and reporting customization.
• Expert: Utilizes advanced alignments, custom scripting, and device diagnostics for complex inspections.

5. Core User Flows

• Operator connects and calibrates devices -> follows guided inspection sequence -> probes features -> reviews results -> exports report.
• Engineer creates inspection plan -> performs detailed analysis using feature tree -> customizes report -> exports findings.
• Expert performs advanced alignment -> uses custom scripts for automation -> diagnoses devices -> exports detailed diagnostics.

6. Visuals Colors and Theme

• primary: #1A73E8 (a deep blue for brand identity)
• primary_light: #E8F0FE (a light blue for hover states)
• secondary: #FF7043 (a coral hue for emphasis and links)
• accent: #FFC107 (a vibrant amber for CTAs and badges)
• highlight: #FFEB3B (a warm yellow for notifications and active indicators)
• bg: #F5F5F5 (a soft gray for page background)
• surface: rgba(255, 255, 255, 0.9) (a white for card/panel backgrounds)
• text: #212121 (a dark gray for primary text)
• text_muted: #757575 (a medium gray for secondary text)
• border: rgba(0, 0, 0, 0.1) (a subtle black for borders)

7. Signature Design Concept

The met_test platform will feature an interactive 3D workspace where users can manipulate inspection tools and devices in a virtual environment. Using @react-three/fiber and @react-three/drei, the homepage will present a dynamic 3D model of a workshop. Users can click and drag to explore different inspection stations, each representing a feature of the platform. Hovering over a station will provide a brief description and clicking will dive into detailed workflows. This immersive experience will make the platform engaging and intuitive, offering a hands-on feel to digital inspection processes.

8. Interaction Model & Motion Direction

The landing page will employ a "parallax" interaction model, creating a layered depth effect as users scroll. Decorative elements like atmospheric blobs and distant shapes will move at different speeds, enhancing the storytelling aspect. Each section will have a distinctive core mechanic, such as a 3D scene or kinetic typography, ensuring a visually rich first impression.

9. Non-Functional Requirements

• The system must support seamless switching between different user modes.
• The platform should be responsive and accessible across various devices and screen sizes.
• The system should ensure data integrity and security during inspections and report generation.

10. Tech Stack

• Frontend: React for Web
• Backend: Python, FastAPI
• Database: MySQL or MariaDB, using Alembic for migrations
• AI Models: Not specified
• AI Tools: Not specified
• Local Orchestration: Docker, docker-compose
• Server-side Orchestration: Kubernetes

11. Assumptions and Constraints

• The platform will be primarily used in Portugal, considering local language and timezone settings.
• Users require flexible configuration options to tailor the platform to their specific workflows.
• The system should integrate seamlessly with existing measurement devices and tools.

12. Glossary

• GD&T: Geometric Dimensioning and Tolerancing
• 3D Scan: A process of capturing the three-dimensional shape of an object.
• Wizard-based Workflows: Step-by-step guided processes to complete tasks.
• Pass/Fail Focus: Emphasis on determining whether an inspection meets predefined criteria.