How rish170/jarvis works
Project type and purpose
• From the file tree and empty README, we infer this is a Python-based hardware/test automation tool.
• It consists of a “controller” that runs system checks, driven by a YAML configuration, and two test suites: hardware tests (e.g., microphone tests) and automation tests.
File structure
• Top-level:
• config/config.yaml — configuration for which tests to run and parameters
• controller/system_check.py — the orchestration entry point
• requirements.txt — Python dependencies
• tests/automation/automation_test.py — test harness for automation
• tests/hardware/mic_test.py — test harness for hardware
• Patterns:
• A centralized controller invokes pluggable test modules
• Config-driven behavior
• Separate directories for different test categories
• Test harnesses likely import hardware interfaces or automation APIs
Main components and their relationships
a. Components
1. Controller Service
– system_check.py reads config, schedules and invokes tests
2. Configuration Store
– config.yaml defines which tests run, thresholds, hardware endpoints
3. Test Modules
– Hardware Test Module(s): e.g., mic_test.py interacts with physical hardware
– Automation Test Module(s): e.g., automation_test.py drives software/firmware automation
4. Results Logger
– Could be console output, log file, or external logging service (not shown in tree; infer a logging component)
5. Dependency Manager
– requirements.txt defines library dependencies such as PyYAML, pytest, hardware SDKs
b. Relationships / Data Flow
• Controller loads config → initializes test modules → invokes hardware and automation APIs → gathers results → passes results to logger.
• Test modules may directly interface with hardware drivers or automation frameworks.
• Logger writes to console or files.
Architectural patterns and design principles
• Plugin-style test harness: each test resides in its own module/directory.
• Single responsibility: controller only orchestrates; tests focus on validation logic.
• Config-driven orchestration: behavior can change without code edits.
• Separation of concerns: config, controller, tests, and dependencies are clearly isolated.
Relevant technologies
• Python 3.x
• PyYAML (for config parsing)
• pytest or unittest (for test execution)
• Hardware SDK (imported in mic_test.py, implied)
• Logging library (Python’s logging module)
2. Center the Controller service.
5. Connect:
– Config → Controller (“YAML settings”)
– Controller → Hardware Tests (“run mic_test”)
– Controller → Automation Tests (“run automation_test”)
– Hardware Tests → Logger (“test results”)
– Automation Tests → Logger (“test results”)
6. If desired, annotate that requirements.txt ties in external libraries used by both controller and test modules.