Merge branch 'fix/fmu-doc' into 'develop'

Update FMU documentation (input and output signals)

See merge request !273

doc/source/user_guide/sim_user_guide/components/vehicle.rst

@@ -282,6 +282,11 @@ The allowed inputs (simulation values) are as follows:
    LaneCountRight                            Integer            Number of lanes to the right of front center of type Driving, Exit, Entry, OnRamp or OffRamp
    SpeedLimit\_\ *X*                         Real               Speed limit in effect in distance *X* meters from front center (999, if no speed limit)
    RoadCurvature\_\ *X*                      Real               Road curvature in distance *X* meters from front center
+   IndicatorState                            Enum               State of the object's indicators (off/center, left, right, warn)
+   HornSwitch                                Bool               true, if the horn is currently activated, false otherwise
+   HeadLightSwitch                           Bool               true, if the head lights are currently activated, false otherwise
+   HighBeamLightSwitch                       Bool               true, if the high beam lights are currently activated, false otherwise
+   FlasherSwitch                             Bool               true, if the flasher is currently activated, false otherwise
    ========================================= ================== ==================================================================================================
 
 * **reference point**: Center of the rear axle
@@ -328,32 +333,37 @@ This means the output type is one of the following:
    :class: tight-table
    :name: Output simulation signals
 
-   ====================================== =================== =========================================
-   Type                                   FMU Variable Type   Enum Values
-   ====================================== =================== =========================================
-   ComponentState                         Enum                Undefined, Disabled, Armed, Acting
-   AccelerationSignal_Acceleration        Real
-   LongitudinalSignal_AccPedalPos         Real
-   LongitudinalSignal_BrakePedalPos       Real
-   LongitudinalSignal_Gear                Int
-   SteeringSignal_SteeringWheelAngle      Real
-   DynamicsSignal_Acceleration            Real
-   DynamicsSignal_Velocity                Real
-   DynamicsSignal_PositionX               Real
-   DynamicsSignal_PositionY               Real
-   DynamicsSignal_Yaw                     Real
-   DynamicsSignal_YawRate                 Real
-   DynamicsSignal_YawAcceleration         Real
-   DynamicsSignal_SteeringWheelAngle      Real
-   DynamicsSignal_CentripetalAcceleration Real
-   DynamicsSignal_TravelDistance          Real
-   CompCtrlSignal_MovementDomain          Enum                Undefined, Lateral, Longitudinal, Both
-   CompCtrlSignal_WarningActivity         Bool
-   CompCtrlSignal_WarningLevel            Enum                INFO, WARNING
-   CompCtrlSignal_WarningType             Enum                OPTIC, ACOUSTIC, HAPTIC
-   CompCtrlSignal_WarningIntensity        Enum                LOW, MEDIUM, HIGH
-   CompCtrlSignal_WarningDirection        Enum
-   ====================================== =================== =========================================
+   ============================================== =================== =========================================
+   Type                                           FMU Variable Type   Enum Values
+   ============================================== =================== =========================================
+   ComponentState                                 Enum                Undefined, Disabled, Armed, Acting
+   AccelerationSignal_Acceleration                Real
+   LongitudinalSignal_AccPedalPos                 Real
+   LongitudinalSignal_BrakePedalPos               Real
+   LongitudinalSignal_Gear                        Int
+   SteeringSignal_SteeringWheelAngle              Real
+   DynamicsSignal_Acceleration                    Real
+   DynamicsSignal_Velocity                        Real
+   DynamicsSignal_PositionX                       Real
+   DynamicsSignal_PositionY                       Real
+   DynamicsSignal_Yaw                             Real
+   DynamicsSignal_YawRate                         Real
+   DynamicsSignal_YawAcceleration                 Real
+   DynamicsSignal_SteeringWheelAngle              Real
+   DynamicsSignal_CentripetalAcceleration         Real
+   DynamicsSignal_TravelDistance                  Real
+   CompCtrlSignal_MovementDomain                  Enum                Undefined, Lateral, Longitudinal, Both
+   CompCtrlSignal_WarningActivity                 Bool
+   CompCtrlSignal_WarningLevel                    Enum                INFO, WARNING
+   CompCtrlSignal_WarningType                     Enum                OPTIC, ACOUSTIC, HAPTIC
+   CompCtrlSignal_WarningIntensity                Enum                LOW, MEDIUM, HIGH
+   CompCtrlSignal_WarningDirection                Enum
+   SecondaryDriverTasksSignal_IndicatorState      Int
+   SecondaryDriverTasksSignal_HornSwitch          Bool
+   SecondaryDriverTasksSignal_HeadLightSwitch     Bool
+   SecondaryDriverTasksSignal_HighBeamLightSwitch Bool
+   SecondaryDriverTasksSignal_FlasherSwitch       Bool
+   ============================================== =================== =========================================
 
 If one of these fields of a signal (except ComponentState) is mapped to an FMU variable, all fields of this signal have to be mapped.
 If the ComponentState is mapped to a FMU variable, it is used for all signals, otherwise it defaults to Acting.

scenario_api_support.md

@@ -96,8 +96,8 @@
 | ------------------| ----------------------|
 | SetProperties     | ❌ Not yet implemented |
 | GetProperties     | ✔️ Implemented         |
-| SetIndicatorState | ❌ Not yet implemented |
-| GetIndicatorState | ❌ Not yet implemented |
+| SetIndicatorState | ✔️ Implemented         |
+| GetIndicatorState | ✔️ Implemented         |
 | ------------------| ----------------------|
 
 # IPedestrian