From 2c5c54a3d5ac03ea616bc0ef1eecf6278a5e8e7d Mon Sep 17 00:00:00 2001 From: Silvan Date: Thu, 27 Aug 2026 15:31:59 +0200 Subject: [PATCH] chore(ice): improve format and description of ICEControl.msg Signed-off-by: Silvan --- .../InternalCombustionEngineControl.md | 44 +++++++++++++------ msg/InternalCombustionEngineControl.msg | 20 ++++++--- 2 files changed, 44 insertions(+), 20 deletions(-) diff --git a/docs/en/msg_docs/InternalCombustionEngineControl.md b/docs/en/msg_docs/InternalCombustionEngineControl.md index 9da327faa71..e4a1e975bd0 100644 --- a/docs/en/msg_docs/InternalCombustionEngineControl.md +++ b/docs/en/msg_docs/InternalCombustionEngineControl.md @@ -4,18 +4,26 @@ pageClass: is-wide-page # InternalCombustionEngineControl (UORB message) +Internal combustion engine (ICE) actuator setpoints. + +Published by the internal_combustion_engine_control module, which runs the engine +start/stop state machine and the idle RPM governor. +The mixer maps these setpoints onto the IC Engine output functions (ignition, +throttle, choke, starter), which are assigned to the flight controller outputs. +The resulting state machine state is reported in InternalCombustionEngineStatus. + **TOPICS:** internal_combustion_engine_control ## Fields -| Name | Type | Unit [Frame] | Range/Enum | Description | -| ------------------------------------------------------------- | --------- | ------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------- | -| timestamp | `uint64` | | | time since system start (microseconds) | -| ignition_on | `bool` | | | activate/deactivate ignition (spark plug) | -| throttle_control | `float32` | | | setpoint for throttle actuator, with slew rate if enabled, idles with 0 [norm] [@range 0,1] [@uncontrolled NAN to stop motor] | -| choke_control | `float32` | | | setpoint for choke actuator, 1: fully closed [norm] [@range 0,1] | -| starter_engine_control | `float32` | | | setpoint for (electric) starter motor [norm] [@range 0,1] | -| user_request | `uint8` | | | user intent for the ICE being on/off | +| Name | Type | Unit [Frame] | Range/Enum | Description | +| ------------------------------------------------------------- | --------- | ------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| timestamp | `uint64` | us | | Time since system start | +| ignition_on | `bool` | | | Activate/deactivate the ignition (spark plug) | +| throttle_control | `float32` | norm | [0 : 1] | Throttle actuator setpoint, rate limited by ICE_THR_SLEW. 0 is closed throttle (Invalid: NaN Stops the engine, output goes to its disarmed value) | +| choke_control | `float32` | norm | [0 : 1] | Choke actuator setpoint, 1 is fully closed | +| starter_engine_control | `float32` | norm | [0 : 1] | (Electric) starter motor setpoint | +| user_request_motor_on | `bool` | | | User intent for the engine to be running, from the source selected by ICE_ON_SOURCE | ## Source Message @@ -24,14 +32,22 @@ pageClass: is-wide-page ::: details Click here to see original file ```c -uint64 timestamp # time since system start (microseconds) +# Internal combustion engine (ICE) actuator setpoints +# +# Published by the internal_combustion_engine_control module, which runs the engine +# start/stop state machine and the idle RPM governor. +# The mixer maps these setpoints onto the IC Engine output functions (ignition, +# throttle, choke, starter), which are assigned to the flight controller outputs. +# The resulting state machine state is reported in InternalCombustionEngineStatus. -bool ignition_on # activate/deactivate ignition (spark plug) -float32 throttle_control # setpoint for throttle actuator, with slew rate if enabled, idles with 0 [norm] [@range 0,1] [@uncontrolled NAN to stop motor] -float32 choke_control # setpoint for choke actuator, 1: fully closed [norm] [@range 0,1] -float32 starter_engine_control # setpoint for (electric) starter motor [norm] [@range 0,1] +uint64 timestamp # [us] Time since system start -uint8 user_request # user intent for the ICE being on/off +bool ignition_on # Activate/deactivate the ignition (spark plug) +float32 throttle_control # [norm] [@range 0, 1] [@invalid NaN Stops the engine, output goes to its disarmed value] Throttle actuator setpoint, rate limited by ICE_THR_SLEW. 0 is closed throttle +float32 choke_control # [norm] [@range 0, 1] Choke actuator setpoint, 1 is fully closed +float32 starter_engine_control # [norm] [@range 0, 1] (Electric) starter motor setpoint + +bool user_request_motor_on # User intent for the engine to be running, from the source selected by ICE_ON_SOURCE ``` ::: diff --git a/msg/InternalCombustionEngineControl.msg b/msg/InternalCombustionEngineControl.msg index 71a93317a94..04d33dba835 100644 --- a/msg/InternalCombustionEngineControl.msg +++ b/msg/InternalCombustionEngineControl.msg @@ -1,8 +1,16 @@ -uint64 timestamp # time since system start (microseconds) +# Internal combustion engine (ICE) actuator setpoints +# +# Published by the internal_combustion_engine_control module, which runs the engine +# start/stop state machine and the idle RPM governor. +# The mixer maps these setpoints onto the IC Engine output functions (ignition, +# throttle, choke, starter), which are assigned to the flight controller outputs. +# The resulting state machine state is reported in InternalCombustionEngineStatus. -bool ignition_on # activate/deactivate ignition (spark plug) -float32 throttle_control # setpoint for throttle actuator, with slew rate if enabled, idles with 0 [norm] [@range 0,1] [@uncontrolled NAN to stop motor] -float32 choke_control # setpoint for choke actuator, 1: fully closed [norm] [@range 0,1] -float32 starter_engine_control # setpoint for (electric) starter motor [norm] [@range 0,1] +uint64 timestamp # [us] Time since system start -bool user_request_motor_on # user intent for the ICE being on/off +bool ignition_on # Activate/deactivate the ignition (spark plug) +float32 throttle_control # [norm] [@range 0, 1] [@invalid NaN Stops the engine, output goes to its disarmed value] Throttle actuator setpoint, rate limited by ICE_THR_SLEW. 0 is closed throttle +float32 choke_control # [norm] [@range 0, 1] Choke actuator setpoint, 1 is fully closed +float32 starter_engine_control # [norm] [@range 0, 1] (Electric) starter motor setpoint + +bool user_request_motor_on # User intent for the engine to be running, from the source selected by ICE_ON_SOURCE