ecu
26 items · generated by scribe fromstdlib/ecu.fd· synced 2026-11-15
Contents
- ECU_STATE_INIT: (const)
- ecu_state_name (function)
- SensorReading (struct)
- sensor_ok (function)
- sensor_fault (function)
- sensor_validate (function)
- sensor_raw_to_value (function)
- ActuatorCommand (struct)
- actuator_command (function)
- actuator_rate_limit (function)
- PIDController (struct)
- pid_new (function)
- pid_set_limits (function)
- pid_set_integral_limits (function)
- pid_compute (function)
- pid_reset (function)
- CalParam (struct)
- cal_param_new (function)
- cal_param_set (function)
- cal_param_get (function)
- cal_param_is_valid (function)
- Watchdog (struct)
- watchdog_new (function)
- watchdog_kick (function)
- watchdog_check (function)
- watchdog_is_expired (function)
ECU_STATE_INIT:
pub const ECU_STATE_INIT: i64 = 0; pub const ECU_STATE_RUN: i64 = 1; pub const ECU_STATE_SHUTDOWN: i64 = 2; pub const ECU_STATE_FAULT: i64 = 3; pub const ECU_STATE_LIMP_HOME: i64 = 4;Defined at line 23
ecu_state_name
Get ECU state name.
pub fn ecu_state_name(state: i64) -> str {Parameters:
state:i64
Returns: str
Defined at line 25
SensorReading
A sensor reading with validity and timestamp.
pub struct SensorReading {Fields:
| Name | Type |
|---|---|
value | f64 |
raw_value | i64 |
is_valid | bool |
timestamp | i64 |
error_code | i64 |
Defined at line 47
sensor_ok
Create a valid sensor reading.
pub fn sensor_ok(value: f64, raw: i64, timestamp: i64) -> SensorReading {Parameters:
value:f64raw:i64timestamp:i64
Returns: SensorReading
Defined at line 56
sensor_fault
Create an invalid sensor reading (sensor fault).
pub fn sensor_fault(error_code: i64, timestamp: i64) -> SensorReading {Parameters:
error_code:i64timestamp:i64
Returns: SensorReading
Defined at line 63
sensor_validate
Validate a sensor reading against min/max range.
pub fn sensor_validate(reading: SensorReading, min_val: f64, max_val: f64) -> SensorReading {Parameters:
reading:SensorReadingmin_val:f64max_val:f64
Returns: SensorReading
Defined at line 70
sensor_raw_to_value
Convert raw ADC value to engineering value (linear conversion).
pub fn sensor_raw_to_value(raw: i64, raw_min: i64, raw_max: i64, eng_min: f64, eng_max: f64) -> f64 {Parameters:
raw:i64raw_min:i64raw_max:i64eng_min:f64eng_max:f64
Returns: f64
Defined at line 83
ActuatorCommand
An actuator command with safety limits.
pub struct ActuatorCommand {Fields:
| Name | Type |
|---|---|
value | f64 |
clamped | bool |
limited | bool |
Defined at line 95
actuator_command
Create an actuator command with safety clamping.
pub fn actuator_command(value: f64, min_val: f64, max_val: f64) -> ActuatorCommand {Parameters:
value:f64min_val:f64max_val:f64
Returns: ActuatorCommand
Defined at line 102
actuator_rate_limit
Apply a rate limit to an actuator command. Limits how fast the command can change per time step.
pub fn actuator_rate_limit(target: f64, current: f64, max_rate: f64) -> f64 {Parameters:
target:f64current:f64max_rate:f64
Returns: f64
Defined at line 120
PIDController
A PID controller state.
pub struct PIDController {Fields:
| Name | Type |
|---|---|
kp | f64 |
ki | f64 |
kd | f64 |
integral | f64 |
prev_error | f64 |
output_min | f64 |
output_max | f64 |
integral_min | f64 |
integral_max | f64 |
Defined at line 137
pid_new
Create a new PID controller.
pub fn pid_new(kp: f64, ki: f64, kd: f64) -> PIDController {Parameters:
kp:f64ki:f64kd:f64
Returns: PIDController
Defined at line 150
pid_set_limits
Set output limits.
pub fn pid_set_limits(pid: & mut PIDController, out_min: f64, out_max: f64) -> void {Parameters:
pid:& mut PIDControllerout_min:f64out_max:f64
Returns: void
Defined at line 157
pid_set_integral_limits
Set integral anti-windup limits.
pub fn pid_set_integral_limits(pid: & mut PIDController, int_min: f64, int_max: f64) -> void {Parameters:
pid:& mut PIDControllerint_min:f64int_max:f64
Returns: void
Defined at line 163
pid_compute
Compute PID output for one time step. setpoint: desired value, measured: current value, dt: time step in seconds
pub fn pid_compute(pid: & mut PIDController, setpoint: f64, measured: f64, dt: f64) -> f64 {Parameters:
pid:& mut PIDControllersetpoint:f64measured:f64dt:f64
Returns: f64
Defined at line 171
pid_reset
Reset PID controller state.
pub fn pid_reset(pid: & mut PIDController) -> void {Parameters:
pid:& mut PIDController
Returns: void
Defined at line 200
CalParam
A calibration parameter.
pub struct CalParam {Fields:
| Name | Type |
|---|---|
name | str |
value | f64 |
min_val | f64 |
max_val | f64 |
unit | str |
Defined at line 211
cal_param_new
Create a calibration parameter.
pub fn cal_param_new(name: str, value: f64, min_val: f64, max_val: f64, unit: str) -> CalParam {Parameters:
name:strvalue:f64min_val:f64max_val:f64unit:str
Returns: CalParam
Defined at line 220
cal_param_set
Set a calibration parameter value (clamped to range).
pub fn cal_param_set(param: & mut CalParam, value: f64) -> void {Parameters:
param:& mut CalParamvalue:f64
Returns: void
Defined at line 227
cal_param_get
Get a calibration parameter value.
pub fn cal_param_get(param: CalParam) -> f64 {Parameters:
param:CalParam
Returns: f64
Defined at line 239
cal_param_is_valid
Validate a calibration parameter is within range.
pub fn cal_param_is_valid(param: CalParam) -> bool {Parameters:
param:CalParam
Returns: bool
Defined at line 244
Watchdog
A watchdog timer.
pub struct Watchdog {Fields:
| Name | Type |
|---|---|
timeout_ms | i64 |
last_kick | i64 |
expired | bool |
Defined at line 254
watchdog_new
Create a new watchdog timer.
pub fn watchdog_new(timeout_ms: i64) -> Watchdog {Parameters:
timeout_ms:i64
Returns: Watchdog
Defined at line 261
watchdog_kick
Kick the watchdog (reset the timer).
pub fn watchdog_kick(wd: & mut Watchdog, current_time: i64) -> void {Parameters:
wd:& mut Watchdogcurrent_time:i64
Returns: void
Defined at line 268
watchdog_check
Check if the watchdog has expired.
pub fn watchdog_check(wd: & mut Watchdog, current_time: i64) -> bool {Parameters:
wd:& mut Watchdogcurrent_time:i64
Returns: bool
Defined at line 274
watchdog_is_expired
Check if watchdog is expired without updating state.
pub fn watchdog_is_expired(wd: Watchdog) -> bool {Parameters:
wd:Watchdog
Returns: bool
Defined at line 283
Generated by scribe, the Fides documentation generator