chore(ice): improve format and description of ICEControl.msg

Signed-off-by: Silvan <silvan@auterion.com>
This commit is contained in:
Silvan authored and Silvan Fuhrer committed 2026-09-24 12:10:34 +02:00
1 parent 6a63433195
commit 2c5c54a3d5
2 files changed
+44 -20

No files matched your search

@@ -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 |
| ------------------------------------------------------------- | --------- | ------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------- |
| <a id="fld_timestamp"></a>timestamp | `uint64` | | | time since system start (microseconds) |
| <a id="fld_ignition_on"></a>ignition_on | `bool` | | | activate/deactivate ignition (spark plug) |
| <a id="fld_throttle_control"></a>throttle_control | `float32` | | | setpoint for throttle actuator, with slew rate if enabled, idles with 0 [norm] [@range 0,1] [@uncontrolled NAN to stop motor] |
| <a id="fld_choke_control"></a>choke_control | `float32` | | | setpoint for choke actuator, 1: fully closed [norm] [@range 0,1] |
| <a id="fld_starter_engine_control"></a>starter_engine_control | `float32` | | | setpoint for (electric) starter motor [norm] [@range 0,1] |
| <a id="fld_user_request"></a>user_request | `uint8` | | | user intent for the ICE being on/off |
| Name | Type | Unit [Frame] | Range/Enum | Description |
| ------------------------------------------------------------- | --------- | ------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="fld_timestamp"></a>timestamp | `uint64` | us | | Time since system start |
| <a id="fld_ignition_on"></a>ignition_on | `bool` | | | Activate/deactivate the ignition (spark plug) |
| <a id="fld_throttle_control"></a>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) |
| <a id="fld_choke_control"></a>choke_control | `float32` | norm | [0 : 1] | Choke actuator setpoint, 1 is fully closed |
| <a id="fld_starter_engine_control"></a>starter_engine_control | `float32` | norm | [0 : 1] | (Electric) starter motor setpoint |
| <a id="fld_user_request_motor_on"></a>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
```
:::
+14 -6
View File
@@ -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