OSQAr Example (Python): Temperature Monitor

Contents:

• Safety & Functional Requirements
  • Safety Goal
  • Safety Requirements
  • Functional Requirements
  • Design Specifications
  • Test Coverage Mapping
• System Architecture
  • Component Architecture
  • Data Flow & Timing
  • Signal Definition
  • Error Handling
  • SEooC Boundary Definition
  • Safety Case (GSN)
• Verification & Test Plan
  • Verification Strategy
  • Test Methods Overview
  • Unit Test Cases
  • Integration Test Cases
  • Traceability Matrix
  • Detailed Traceability Table
  • Test Execution & Reporting
• Implementation & Test Code
  • Code Organization
  • Implementation Traceability
  • Example: Sensor Driver Implementation
  • State Machine Example
  • Test Suite Mapping
  • Test Execution & Reporting
  • Test Results Integration
  • Building the Full Chain
  • Code Repository Structure
  • Extending the Example
• Test Results & Traceability
  • Overview
  • Test Suite Execution
  • Test Configuration File
  • Test Requirements Mapping
  • Traceability Matrix
  • Automated Test Reporting
  • Code Coverage
  • Complexity report
  • Building Traceability Outputs
  • Traceability Output Checklist
  • Next Steps
• Lifecycle Management
  • Purpose
  • What is a “shipment” in this example?
  • Change scenarios and required actions
  • Multi-language note
  • Notes and pitfalls
  • Worked example (requirement change)
  • Supplier workflow (produce shipment)
  • Integrator workflow (verify shipment)
  • Archiving and traceability continuity

Overview

The contents of this example have been fully generated by LLMs. It shall only serve as a reference on how a toolchain setup could look like.

This Python example is intentionally easy to run on a developer workstation to demonstrate OSQAr concepts (needs IDs, traceability, JUnit import, and Sphinx rendering).

It is not intended as an embedded implementation language for safety-related systems. For safety-related embedded projects, prefer C or Rust (and treat C++ with caution).

This documentation demonstrates the Thermal Sensor Interface Module (TSIM) pattern, using OSQAr to annotate and trace requirements through architecture, implementation, and tests.

Illustrative Domain Examples: This component pattern could apply to domains such as:

• Medical devices (incubators, sterilizers)

• Industrial machinery (process monitoring)

• Robotics (motor/actuator thermal management)

• Automotive (battery/power system monitoring)

• Aerospace (component thermal limits)

Key Documents

1. Safety & Functional Requirements - Example safety, functional, and design requirements

2. System Architecture - System architecture and data flow

3. Verification & Test Plan - Test methods and verification approach

4. Implementation & Test Code - Code examples and test suite implementation

5. Test Results & Traceability - Automated test integration and traceability reporting

Traceability Outputs

This documentation produces:

• Linked Requirements with traceability IDs and cross-references

• Traceability Matrix linking requirements → design → verification

• Verification Mapping with test case documentation