sm_led_indication
=================

State machine mapping operating and fault states to RGB LED indication states.

Inherited Component
-------------------

- :doc:`Status_Indication_Manager </generated/architecture/status-indication-manager-aa910425-e9ef-4a91-ab5f-b0f1a7cccfaf>`

Inherited Requirements
----------------------

- :doc:`REQ-IFC-005 </generated/requirements/req-ifc-005-e9ec1206-b39c-49ec-bece-33c3fb8a40a0>`
- :doc:`REQ-DIA-003 </generated/requirements/req-dia-003-fab25824-204a-4ab2-8dab-4151b35d10d8>`

Relationship Diagram
--------------------

.. image:: /_static/sw_unit_uml/sm_led_indication_be8f98bd-0265-4e8f-95ec-b60afe9779f5_uml.svg
   :alt: UML class diagram for sm_led_indication
   :class: dblclick-open-image


SW Unit Relations
-----------------


Incoming Relations
~~~~~~~~~~~~~~~~~~

.. list-table::
   :header-rows: 1

   * - Relation
     - UML Type
     - Visibility
     - Source Unit
     - Description
   * - :doc:`SWR-006 </generated/detailed_design/relations/swr-006-154273ba-3076-4542-b7dc-89006e5df609>`
     - composition
     - private
     - :doc:`ao_status_indication </generated/detailed_design/units/ao-status-indication-2f37d667-1c29-4f37-b12f-138196fec6b0>`
     - Status indication active object embeds LED indication state machine.

Data Types
----------

.. _dt-d1dc04e4-712b-41dc-bf6b-57e679c632b7:

.. raw:: html

   <span id="dt-d1dc04e4-712b-41dc-bf6b-57e679c632b7"></span><div class="sw-dt-title"><span class="sw-dt-name">sm_led_indication_context</span><span class="sw-dt-badge sw-dt-badge-struct">struct</span></div>

Internal runtime context for sm_led_indication.

.. rubric:: Struct Members

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Description
   * - sm_state
     - :ref:`uint8_t <dt-45402023-5ffe-4540-ba19-64896d87b3dc>`
     - LED SM current state.
   * - pattern_code
     - :ref:`uint8_t <dt-45402023-5ffe-4540-ba19-64896d87b3dc>`
     - Active pattern code.
   * - blink_enabled
     - :ref:`bool <dt-c71dfd1b-cce2-471d-a034-2a7bdc7b8d25>`
     - Blink state.
   * - transition_tick
     - :ref:`uint32_t <dt-9930f975-8f88-4930-9e5b-64c21de2689a>`
     - Last transition tick.

.. _dt-0994811c-ec75-4994-9f33-872d91ca16f3:

.. raw:: html

   <span id="dt-0994811c-ec75-4994-9f33-872d91ca16f3"></span><div class="sw-dt-title"><span class="sw-dt-name">sm_led_indication_event</span><span class="sw-dt-badge sw-dt-badge-struct">struct</span></div>

Event payload handled by sm_led_indication.

.. rubric:: Struct Members

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Description
   * - signal_id
     - :ref:`uint16_t <dt-036d66c4-d7f5-436d-8f41-bf413e2d3351>`
     - LED SM event id.
   * - mode_code
     - :ref:`uint8_t <dt-45402023-5ffe-4540-ba19-64896d87b3dc>`
     - Mode code input.
   * - warning_active
     - :ref:`bool <dt-c71dfd1b-cce2-471d-a034-2a7bdc7b8d25>`
     - Warning input.
   * - fault_active
     - :ref:`bool <dt-c71dfd1b-cce2-471d-a034-2a7bdc7b8d25>`
     - Fault input.

.. _dt-95793e0d-98bd-4579-9da5-65538737c15f:

.. raw:: html

   <span id="dt-95793e0d-98bd-4579-9da5-65538737c15f"></span><div class="sw-dt-title"><span class="sw-dt-name">sm_led_indication_result</span><span class="sw-dt-badge sw-dt-badge-enum">enum</span></div>

Result code for sm_led_indication operations.

.. rubric:: Enum Members

.. list-table::
   :header-rows: 1

   * - Name
     - Value
     - Description
   * - OK
     - 0
     - LED SM transition applied.
   * - INVALID_TRANSITION
     - 1
     - Transition rejected by guard.
   * - PATTERN_LATCHED
     - 2
     - Fault pattern latched.



Attributes
----------

.. list-table::
   :header-rows: 1

   * - Attribute
     - Type
     - Visibility
     - Description
   * - ctx
     - :ref:`sm_led_indication_context <dt-d1dc04e4-712b-41dc-bf6b-57e679c632b7>`
     - private
     - Runtime context for sm_led_indication state timing and error tracking.

Methods
-------

dispatch
~~~~~~~~

- **Return Type:** :ref:`sm_led_indication_result <dt-95793e0d-98bd-4579-9da5-65538737c15f>`
- **Visibility:** public
- **Description:** Process one sm_led_indication event and update runtime outputs.

.. rubric:: Parameters

.. list-table::
   :header-rows: 1

   * - Name
     - Type
     - Direction
     - Description
   * - event
     - :ref:`sm_led_indication_event <dt-0994811c-ec75-4994-9f33-872d91ca16f3>`
     - in
     - Process one sm_led_indication event and update runtime outputs.

init
~~~~

- **Return Type:** :ref:`sm_led_indication_result <dt-95793e0d-98bd-4579-9da5-65538737c15f>`
- **Visibility:** public
- **Description:** Initialize sm_led_indication runtime state and dependencies.



Dynamic Behaviour
-----------------


State Machines
~~~~~~~~~~~~~~

sm_led_indication_state
^^^^^^^^^^^^^^^^^^^^^^^

.. uml::

   @startuml
   hide empty description
   
   
   [*] --> Led_Off
   Led_Off --> Led_Normal : EVT_STATUS_NORMAL
   
   Led_Normal --> Led_Warning : EVT_STATUS_WARNING
   Led_Warning --> Led_Normal : EVT_STATUS_NORMAL
   
   Led_Normal --> Led_Protective : EVT_STATUS_PROTECTIVE
   Led_Warning --> Led_Protective : EVT_STATUS_PROTECTIVE
   Led_Protective --> Led_Normal : EVT_STATUS_NORMAL
   
   Led_Normal --> Led_Fault : EVT_FAULT_SET
   Led_Warning --> Led_Fault : EVT_FAULT_SET
   Led_Protective --> Led_Fault : EVT_FAULT_SET
   Led_Fault --> Led_Normal : EVT_FAULT_CLEAR
   
   Led_Normal : do / set_led(GREEN)
   Led_Warning : do / set_led(YELLOW)
   Led_Protective : do / set_led(RED_BLINK)
   Led_Fault : do / set_led(RED_SOLID)
   
   @enduml


This state machine defines LED priority rules mapping normal warning protective and fault context into deterministic visual indications and ensures fault signaling dominates lower severity status outputs until explicit clear.





Sequence Diagrams
~~~~~~~~~~~~~~~~~

SEQ-003_Status_To_LED_Indication
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. uml::

   @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.