ao_diagnostics

Active object managing fault and status event processing.

Inherited Component

Inherited Requirements

Relationship Diagram

UML class diagram for ao_diagnostics

SW Unit Relations

Outgoing Relations

Relation

UML Type

Visibility

Target Unit

Description

SWR-015

association

public

ao_status_indication

Diagnostics publishes status events to indication.

Incoming Relations

Relation

UML Type

Visibility

Source Unit

Description

SWR-010

dependency

public

ao_runtime_supervisor

Runtime supervisor dispatches diagnostics events.

SWR-013

association

public

ao_control

Control publishes operational and fault-relevant events to diagnostics.

SWR-014

association

public

ao_safety

Safety publishes protective-state and fault events to diagnostics.

Data Types

ao_diagnostics_contextstruct

Internal runtime context for ao_diagnostics.

Struct Members

Name

Type

Description

fault_state

uint8_t

Fault lifecycle state.

active_fault_code

uint16_t

Current fault code.

fault_latched

bool

Fault latch status.

last_publish_tick

uint32_t

Last diagnostics publish tick.

ao_diagnostics_eventstruct

Event payload handled by ao_diagnostics.

Struct Members

Name

Type

Description

signal_id

uint16_t

Diagnostics event signal id.

fault_code

uint16_t

Fault code payload.

severity

uint8_t

Fault severity level.

clear_request

bool

Fault clear request.

ao_diagnostics_resultenum

Result code for ao_diagnostics operations.

Enum Members

Name

Value

Description

OK

0

Diagnostics update published.

FAULT_CAPTURED

1

Fault captured and reported.

CLEAR_REJECTED

2

Clear rejected by diagnostics policy.

Attributes

Attribute

Type

Visibility

Description

ctx

ao_diagnostics_context

private

Runtime context for ao_diagnostics state timing and error tracking.

Methods

dispatch

  • Return Type: ao_diagnostics_result

  • Visibility: public

  • Description: Process one ao_diagnostics event and update runtime outputs.

Parameters

Name

Type

Direction

Description

event

ao_diagnostics_event

in

Process one ao_diagnostics event and update runtime outputs.

init

  • Return Type: ao_diagnostics_result

  • Visibility: public

  • Description: Initialize ao_diagnostics runtime state and dependencies.

Dynamic Behaviour

State Machines

ao_diagnostics_state

@startuml
hide empty description


[*] --> Diag_Init
Diag_Init --> No_Fault : EVT_INIT_DONE

No_Fault --> Fault_Active : EVT_FAULT_RAISED
Fault_Active --> Fault_Latched : EVT_PROTECT_ACTIVE
Fault_Active --> No_Fault : EVT_FAULT_CLEAR_REQ [no_active_fault]

Fault_Latched : do / keep_last_fault()
Fault_Latched --> No_Fault : EVT_FAULT_CLEAR_REQ [safe_to_clear]

No_Fault : do / publish_status_normal()
Fault_Active : do / publish_status_fault()
Fault_Latched : do / publish_status_protective()

@enduml

This state machine formalizes diagnostics fault lifecycle handling across no fault active fault and latched fault states and clarifies when status publication and fault clear requests are accepted or rejected.

Sequence Diagrams

SEQ-001_Runtime_Event_Orchestration

@startuml

hide footbox
title Runtime Event Orchestration

participant ao_runtime_supervisor
participant evt_timer_service
participant evt_dispatcher
participant ao_monitoring
participant ao_control
participant ao_safety
participant ao_diagnostics
participant ao_modbus_server

ao_runtime_supervisor -> evt_timer_service : init periodic tick
ao_runtime_supervisor -> evt_dispatcher : init event loop
loop each scheduler tick
  evt_timer_service -> ao_runtime_supervisor : tick event
  ao_runtime_supervisor -> evt_dispatcher : dispatch cycle
  evt_dispatcher -> ao_monitoring : monitor_event
  evt_dispatcher -> ao_control : control_event
  evt_dispatcher -> ao_safety : safety_event
  evt_dispatcher -> ao_diagnostics : diagnostics_event
  evt_dispatcher -> ao_modbus_server : comms_event
end

@enduml

Primary runtime interoperability sequence showing scheduler tick propagation through dispatcher fan-out and deterministic active-object processing order across monitoring control safety diagnostics and communication units.

SEQ-002_Protection_And_Fault_Propagation

@startuml

hide footbox
title Control-Safety-Diagnostics Fault Propagation

participant ao_control
participant ao_safety
participant ao_diagnostics

ao_control -> ao_safety : IF_FanCommand(command_request)
ao_safety --> ao_control : IF_FanCommand(override_feedback)

ao_control -> ao_diagnostics : IF_OperatingStatus(control_status)
alt protection or fault detected
  ao_control -> ao_diagnostics : IF_FaultEvent(control_fault)
  ao_safety -> ao_diagnostics : IF_OperatingStatus(protection_state)
end

@enduml

Control and safety coordinate fan command decisions and publish operating/fault status into diagnostics for downstream handling.

SEQ-003_Status_To_LED_Indication

@startuml

hide footbox
title Diagnostic Status To LED Indication

participant ao_diagnostics
participant ao_status_indication
participant sm_led_indication
participant drv_rgb_led

ao_diagnostics -> ao_status_indication : IF_OperatingStatus(system_status)
ao_status_indication -> sm_led_indication : evaluate indication pattern
sm_led_indication -> ao_status_indication : resolved LED intent
ao_status_indication -> drv_rgb_led : IF_StatusLedCommand(led_command)

@enduml

Diagnostics status outputs are transformed by status indication logic into concrete LED driver commands.

SEQ-005_Startup_To_Ready

@startuml
hide footbox
participant ao_runtime_supervisor
participant evt_timer_service
participant evt_dispatcher
participant ao_monitoring
participant ao_control
participant ao_safety
participant ao_diagnostics
participant ao_modbus_server

ao_runtime_supervisor -> evt_timer_service : init()
ao_runtime_supervisor -> evt_dispatcher : init()
ao_runtime_supervisor -> ao_monitoring : init()
ao_runtime_supervisor -> ao_control : init()
ao_runtime_supervisor -> ao_safety : init()
ao_runtime_supervisor -> ao_diagnostics : init()
ao_runtime_supervisor -> ao_modbus_server : init()

group readiness gates
  evt_timer_service --> ao_runtime_supervisor : EVT_TIMER_READY
  evt_dispatcher --> ao_runtime_supervisor : EVT_DISPATCH_READY
  ao_monitoring --> ao_runtime_supervisor : EVT_AO_READY
  ao_control --> ao_runtime_supervisor : EVT_AO_READY
  ao_safety --> ao_runtime_supervisor : EVT_AO_READY
  ao_diagnostics --> ao_runtime_supervisor : EVT_AO_READY
  ao_modbus_server --> ao_runtime_supervisor : EVT_AO_READY
end

ao_runtime_supervisor -> evt_dispatcher : EVT_INIT_OK / start Run
@enduml

Startup lifecycle sequence with explicit readiness gates before entering Run state.

SEQ-006_Degraded_Entry_And_Recovery

@startuml
hide footbox
participant ao_runtime_supervisor
participant evt_dispatcher
participant ao_control
participant ao_safety
participant ao_diagnostics

ao_runtime_supervisor -> evt_dispatcher : dispatch cycle
alt degraded entry criteria met
  note over ao_runtime_supervisor: init_timeout OR required_service_failed OR fatal_fault
  ao_runtime_supervisor -> ao_control : EVT_DEGRADED
  ao_runtime_supervisor -> ao_safety : EVT_DEGRADED
  ao_runtime_supervisor -> ao_diagnostics : EVT_DEGRADED
  ao_runtime_supervisor -> evt_dispatcher : restrict noncritical events
end

ao_runtime_supervisor -> evt_dispatcher : periodic degraded dispatch

alt recovery criteria met
  note over ao_runtime_supervisor: fault_cleared AND watchdog_ok AND required_services_ready
  ao_runtime_supervisor -> evt_dispatcher : EVT_RESET
  ao_runtime_supervisor -> ao_control : EVT_RECOVERY
  ao_runtime_supervisor -> ao_safety : EVT_RECOVERY
  ao_runtime_supervisor -> ao_diagnostics : EVT_RECOVERY
end
@enduml

Lifecycle sequence for degraded entry triggers and guarded recovery back to Run.

SEQ-007_Controlled_Shutdown

@startuml
hide footbox
participant ao_runtime_supervisor
participant evt_dispatcher
participant ao_control
participant ao_safety
participant ao_diagnostics
participant ao_modbus_server

ao_runtime_supervisor -> evt_dispatcher : EVT_SHUTDOWN_REQ
ao_runtime_supervisor -> ao_control : stop outputs to safe state
ao_runtime_supervisor -> ao_safety : keep protective policy active
ao_runtime_supervisor -> ao_diagnostics : publish shutdown status
ao_runtime_supervisor -> ao_modbus_server : stop comm servicing

ao_modbus_server --> ao_runtime_supervisor : EVT_STOPPED
ao_diagnostics --> ao_runtime_supervisor : EVT_STOPPED
ao_safety --> ao_runtime_supervisor : EVT_STOPPED
ao_control --> ao_runtime_supervisor : EVT_STOPPED
evt_dispatcher --> ao_runtime_supervisor : EVT_STOPPED

ao_runtime_supervisor -> ao_runtime_supervisor : EVT_ALL_STOPPED / Shutdown complete
@enduml

Controlled shutdown sequence defining stop ordering and completion criteria.